Znaczniki zalecane dla komentarzy do dokumentacji (Przewodnik programowania w języku C#)

  • Artykuł

Kompilator C# przetwarza komentarzy dokumentacji w kodzie i formatuje je jako XML w pliku o nazwie określonej w /doc opcji wiersza polecenia.Aby utworzyć końcowej dokumentacji, na podstawie pliku generowanych przez kompilator, można utworzyć niestandardowe narzędzie, lub użyć narzędzia, takie jak Sandcastle.

Tagi są przetwarzane na konstrukcje kodu, takie jak typy i wpisz członków.

[!UWAGA]

Nie można zastosować komentarzy dokumentacji do obszaru nazw.

Kompilator będzie przetwarzać dowolny znacznik, który jest prawidłowy dokument XML.Następujące znaczniki udostępniają funkcje stosowana powszechnie w dokumentacji użytkownika.

Tagi

<c>

<para>

<see>*

<code>

<param>*

<seealso>*

<example>

<paramref>

<summary>

<exception>*

<permission>*

<typeparam>*

<include>*

<remarks>

<typeparamref>

<list>

<returns>

<value>

(* oznacza, że kompilator sprawdza składnię.)

Nawiasy kątowe do stawienia się w tekście komentarza dokumentacji, należy użyć &lt; i &gt;, jak pokazano w poniższym przykładzie.

/// <summary cref="C &lt; T &gt;">
/// </summary>

Zobacz też

Informacje

/doc (opcje kompilatora C#)

Komentarze dokumentacji XML (Przewodnik programowania w języku C#)

Koncepcje

Przewodnik programowania w języku C#