Wie fügen Sie < or > zu einem Übersichtstag in Visual Studio hinzu?

Question

Wie fügen Sie < (kleiner als) oder> (größer als) zu einem zusammenfassenden Kommentar in Visual Studio hinzu? Ich bin in Visual Studio 2008.

Ich habe eine generische Methode:

public bool IsMemberProtected<T>(Expression<Func<T, object>> expression) 

Würde gerne eine Zusammenfassung Tag von etwas haben, wie diese

/// <summary> 
    /// Determines whether a member is protected. 
    /// 
    /// Usage: IsMemberProtected<ExampleType>(x => x.Member) 
    /// </summary> 

Aber wenn ich tun Das Tooltipp für die Eigenschaft funktioniert nicht mehr, wenn ein Entwickler die Methode im Code überfliegt, um das Summary-Tag anzuzeigen.

Gedanken?

Answer 1

Sie können die Einheiten < und > verwenden, um < bzw. > anzugeben.

Beachten Sie, dass Sie hier auch < und > verwenden, um einen generischen Typ zu schreiben. In diesem Fall gibt es eine Konvention, dass wenn Sie ein cref Tag verwenden, dann können Sie GenericType{T} statt der hässlicheren GenericType<T> verwenden. Weitere Informationen finden Sie unter here.

Auch von dieser Seite gibt es einen weiteren Vorschlag, wenn Sie eine Menge < und > Symbole schreiben, dass Sie den Text in einem CDATA-Abschnitt setzen:

/// <summary> 
/// This a simple collection which implements <see cref="IEnumerable{T}" /> 
/// </summary> 
/// <example> 
/// <![CDATA[ 
/// SimpleList<int> intList = new SimpleList<int>(); 
/// ]]> 
/// </example> 

Answer 2

Ich denke, das Ihnen helfen kann.

Klicken Sie mit der rechten Maustaste auf die Funktion, wählen Sie "Document this" für Ex.

public void Function_Name() 

wird

/// <summary> 
/// Give the details here 
/// </summary> 
/// <param name=""></param> 
/// <returns> you can tel what it returns </returns> 
public void Function_Name() 

(alles automatisch generiert wird).