2016-07-25 18 views
0

У меня есть класс (написанный на C#) с некоторыми комментариями документации:Visual Studio: Doc Комментарии, которые обновляются при переименовании классов/поля/методы

/// <summary> 
/// Abstract class defining a tolerance-based method for Equals. 
/// Tolerance must be defined in a derived class like this: 
/// <code>class MyPrec : Precision { private MyPrec() : base(42) {} }</code> 
/// (This subclass will have a tolerance of 42.) 
/// </summary> 
public abstract class Precision 
{ 
    protected readonly double TOL; 

    protected Precision(double tol) 
    { 
     TOL = tol; 
    } 

    /// <summary> 
    /// Checks if two doubles are equal up to numerical tolerance given by TOL. 
    /// </summary> 
    /// <param name="left">First double.</param> 
    /// <param name="right">Second double.</param> 
    /// <returns>True if the absolute value of the difference is at most TOL, 
    ///   false otherwise.</returns> 
    public bool Equals(double left, double right) 
    { 
     return Math.Abs(left - right) <= TOL; 
    } 

    /// <summary> 
    /// Not Equals. 
    /// </summary> 
    public bool NotEquals(double left, double right) 
    { 
     return !Equals(left, right); 
    } 
} 

Если переименовать параметр left в методе Equals с помощью Функция переименования Visual Studio автоматически переименовывается в комментарий к документации. Но похоже, что это работает только для непосредственных параметров.

Как написать комментарии к документации, так что Visual Studio изменит следующие слова при переименовании соответствующего класса/поля/метода?

  • Precision в примере кода краткого комментария класса Precision

    /// <code>class MyPrec : Precision { private MyPrec() : base(42) {} }</code> 
    
  • TOL в обратном комментарии метода Equals

    /// <returns>True if the absolute value of the difference is at most TOL, 
    
  • Equals в кратком комментарии от NotEquals

    /// Not Equals. 
    

Я использую Visual Studio 2015.

Я уже пытался

/// <returns>True if the absolute value of the difference is at most <paramref name="TOL"/>, 

но это не работает. В конце концов, это не входной параметр.

+0

Пожалуйста, ваши родственный вопрос как отдельный вопрос. –

ответ

1
  • Прецизионность, я думаю, что это невозможно. Комментарий в коде < > тег - это свободный текст.
  • Для TOL и Equals это просто. Используйте тег <see>, когда вы ссылаетесь на другого члена кода в своих комментариях. Переименование будет применено к таким элементам. В вашем случае комментарий будет:

    /// <returns>True if the absolute value of the difference is at most <see cref="TOL"/>, 
    

и

/// Not <see cref="Equals"/>.