0

以下の xml ドキュメントのコードでは、メソッドの引数のパラメーターの名前と xml ドキュメントのパラメーターの名前が一致していません。xml ドキュメントの署名を自動修正する方法、または resharper で提供されている xml ドキュメントを自動修正する機能はありますか。

#region Get Images

/// <summary>
///  Get Images 
/// </summary>
/// <param name="par1"></param>
/// <param name="par2"></param>
/// <returns></returns>
public Collection<UserImage> GetImages()
{
    return GetImages("");
}

/// <summary>
///  Get Images 
/// </summary>
/// <param name="par1"></param>
/// <param name="par2"></param>
/// <returns></returns>
public Collection<UserImage> GetImages(string imageType)
{
    return GetImages(0, imageType);
}

/// <summary>
///  Get Images 
/// </summary>
/// <param name="par1"></param>
/// <param name="par2"></param>
/// <returns></returns>
public Collection<UserImage> GetImages(int imageId)
{
    return GetImages(imageId, "");
}

/// <summary>
///  Get Images 
/// </summary>
/// <param name="par1"></param>
/// <param name="par2"></param>
/// <returns></returns>
public Collection<UserImage> GetImages(int imageId,string imageType)
{
    return null;
}

#endregion

たとえば、次のような xml ドキュメントを含むメソッドが必要です。

/// <summary>
///  Get Images 
/// </summary>
/// <param name="imageId"></param>
/// <param name="imageType"></param>
/// <returns></returns>
public Collection<UserImage> GetImages(int imageId,string imageType)
{
    return null;
}

#endregion
4

2 に答える 2

6

GhostDoc がこれを行います。インストール後、VS 'Document this' (および対応するキーボード ショートカット) に新しいコンテキスト メニュー項目が表示されます。

XML コメントが存在しない場合は、コメントが追加されます。それらがすでに存在する場合は、必要に応じて更新する必要があります。

http://submain.com/products/ghostdoc.aspx

于 2009-09-19T15:42:37.017 に答える
1

R# で xml を「自動修正」する唯一の方法は、既存の xml ドキュメントを削除して /// をもう一度押すことです。申し訳ありませんが、より良い答えがありません。

R# は xml ドキュメントやメソッド シグネチャを修正する必要がないため、それは不可能だと思います。

于 2009-09-19T15:39:42.843 に答える