的Visual Studio：要重命名的類/字段/方法的時候得到更新的文檔註釋

Question

我有一個類（C＃編寫）的一些文檔註釋：

/// <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); 
    } 
} 

如果我在Equals方法通過重命名參數left Visual Studio的重命名功能，它也自動在文檔評論中重新命名。但它似乎只適用於即時參數。

如何編寫文檔註釋，以便在重命名相應的類/字段/方法時，以下單詞也由Visual Studio更新？

• 在類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在總結註釋返回註釋的總結註釋的代碼示例PrecisionNotEquals

  /// Not Equals. 
  

我使用Visual Studio 2015年

我已經嘗試過

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

，但它不工作。畢竟這不是輸入參數。

Answer 1

• 精度，我認爲這是不可能的。 <代碼>標記內的註釋是一個自由文本。

• 對於TOL和Equals，這很簡單。當您在評論中引用其他代碼成員時，請使用<see>標記。重命名將應用於這些元素。在你的情況的註釋是：

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

和

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