Visual Studio: Doc Kommentare, die aktualisiert werden, wenn Klassen/Felder/Methoden

Question

Umbenennung habe ich eine Klasse (geschrieben in C#) mit einiger Dokumentation Kommentaren:

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

Wenn ich die Parameter left im Equals Methode umbenennen über Die Umbenennungsfunktion von Visual Studio wird automatisch auch im Dokumentationskommentar umbenannt. Aber es scheint, dass dies nur für unmittelbare Parameter funktioniert.

Wie schreibe ich die Kommentare der Dokumentation, so dass die folgenden Wörter auch von Visual Studio beim Umbenennen der entsprechenden Klasse/Feld/Methode aktualisiert werden?

• Precision im Codebeispiel der Zusammenfassung Kommentar der Klasse Precision

  /// <code>class MyPrec : Precision { private MyPrec() : base(42) {} }</code> 
  

• TOL im Rück Kommentar des Verfahrens Equals

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

• Equals in der Zusammenfassung Kommentar von NotEquals

  /// Not Equals. 
  

Ich bin mit Visual Studio 2015

Ich habe bereits versucht

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

aber es funktioniert nicht. Es ist schließlich kein Eingabe-Parameter.

Answer 1

• Präzision, ich denke, das ist nicht möglich. Der Kommentar innerhalb des <Code> Tags ist ein freier Text.

• Für TOL und Gleich ist dies einfach. Verwenden Sie das Tag <see>, wenn Sie in Ihren Kommentaren auf ein anderes Code-Element verweisen. Das Umbenennen wird auf solche Elemente angewendet. In Ihrem Fall wird der Kommentar sein:

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

und

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