Как выполнить автозамену xml документации методов - PullRequest
Новая
       36

Как выполнить автозамену xml документации методов

0 голосов
/ 19 сентября 2009

В приведенном ниже коде в 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

Ответы [ 2 ]

6 голосов
/ 19 сентября 2009

GhostDoc сделает это за вас. После установки вы получаете новый пункт контекстного меню в VS 'Document this' (и соответствующее сочетание клавиш).

Если нет комментариев XML, он их добавит. Если они уже присутствуют, они должны обновляться по мере необходимости.

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

1 голос
/ 19 сентября 2009

Единственный способ, которым я знаю "автокоррекцию" xml с помощью R #, - это удалить существующую документацию xml и снова нажать ///. Извините, у меня нет лучшего ответа.

Я считаю, что это невозможно, потому что R # не требует исправления документации или подписи метода xml.

...