Sdílet prostřednictvím

Doporučené značky pro dokumentační komentáře (Průvodce programováním v C#)

  • Článek

Kompilátor jazyka C# zpracuje dokumentační komentáře v kódu a formátuje je jako data XML v souboru, jehož název určíte v /doc parametr příkazového řádku.Vytvoření konečné dokumentace na základě souboru generovány kompilátoru, můžete vytvořit vlastní nástroj, nebo použijte nástroj jako je například Sandcastle.

Značky jsou zpracovávány na konstrukce kódu, jako jsou typy a zadejte členů.

[!POZNÁMKA]

Obor názvů nelze použít dokumentační komentáře.

Kompilátor bude zpracovávat tag, který je platný kód XML.Následující značky poskytují obecně používané 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.)

V případě potřeby ostré závorky v textu komentáře dokumentaci pomocí &lt; a &gt;, jak je znázorněno v následujícím příkladu.

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

Viz také

Referenční dokumentace

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

Dokumentační komentáře XML (Průvodce programováním v C#)

Koncepty

Průvodce programováním v C#