Wie werden Inline-Kommentare verwendet, um Member in .NET zu dokumentieren?

Question

Wie kann ich ein Mitglied inline in .Net dokumentieren? Lassen Sie mich erklären. Die meisten Tools, die Dokumentation aus Kommentaren extrahieren, unterstützen eine Art von Inline-Dokumentation, in der Sie nach der Member-Deklaration einen Brief hinzufügen können. Etwas wie:

public static string MyField; /// <summary>Information about MyField.</summary> 

Gibt es eine Möglichkeit, dies in C# oder den .NET-Sprachen zu tun?

Answer 1

Nein kommentieren möchten, können Sie nicht. XML-Kommentare werden nur als Kommentar auf Blockebene unterstützt, dh sie müssen vor dem Codeelement platziert werden, das Sie dokumentieren. Die üblichen Tools zum Extrahieren von XML-Kommentaren aus .NET-Code verstehen nicht, wie Inline-Kommentare wie diese analysiert werden. Wenn Sie diese Fähigkeit benötigen, müssen Sie Ihren eigenen Parser schreiben.

Answer 2

Yep, legte es kurz vor dem, was Sie

/// <summary>Information about MyField.</summary> 
public static string MyField; 

Answer 3

Es gibt keine integrierte Möglichkeit, dies zu tun. Das XML-Dokumentationssystem ist hierarchisch; Es definiert eine Beziehung zwischen dem Tag <summary /> und den Daten, die unmittelbar darauf folgen.