Sdílet prostřednictvím

Doporučené značky komentářů dokumentace (C# programování Guide)

  • Článek

Kompilátor jazyka C# zpracovává dokumentaci komentáře v kódu a formátuje je jako XML, v jehož jméno zadat v souboru /doc možnost příkazového řádku.Vytvoření konečné dokumentace založený na souboru generovaných kompilátorem, můžete vytvořit vlastní nástroj nebo nástroj jako Sandcastle.

Značky jsou zpracovány na konstrukce kódu, například typy a zadejte členů.

[!POZNÁMKA]

Komentáře k dokumentaci oboru názvů nelze použít.

Kompilátor bude zpracovávat všechny tag, který je platný kód XML.Následující značky poskytují obvykle používá funkce v uživatelské dokumentaci.

Značky

<c>

<para>

<see>*

<code>

<param>*

<seealso>*

<example>

<paramref>

<summary>

<exception>*

<permission>*

<typeparam>*

<include>*

<remarks>

<typeparamref>

<list>

<returns>

<value>

(* označuje, že kompilátor ověří syntaxi.)

Lomené závorky v text komentáře dokumentaci, použijte &lt; a &gt;, jak ukazuje následující příklad.

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

Viz také

Referenční dokumentace

/doc (Možnosti C# kompilátoru)

Komentáře XML dokumentace (Příručka programování C#)

Koncepty

Příručka programování C#