Oddělovače pro dokumentaci značky (Příručka programování C#)

Použití komentáře XML dokumentu vyžaduje oddělovače, které označují kompilátoru, kde dokumentace komentář začíná a končí.S tagy XML dokumentace můžete použít následující druhy oddělovače:

• ///
  Oddělovač jeden řádek.Toto je formulář, který je v dokumentaci, příklady a použít šablony projektu Visual C#.Pokud znak oddělovače následující znak není součástí výstupu XML.

  [!POZNÁMKA]

  Visual Studio IDE má funkci Inteligentní úpravy komentáře, automaticky vloží <summary> a </summary> značky a přesune kurzor v rámci těchto tagů po zadání /// oddělovač v editoru kódu.Přístup k této funkci z Možnosti editoru textu, C#, formátování na stránkách vlastností projektu.

• /** */
  Víceřádkové oddělovače.

Existují některé formátování pravidla při použití /** */ oddělovače.

• Na řádek, který obsahuje /** oddělovač, pokud je zbývající množství řádku prázdné znaky na řádek není zpracován pro komentáře.Pokud po první znak /** místa, že znak je ignorována a zpracování zbytek řádku je oddělovačem.Jinak celý text za řádek /** oddělovač je zpracován jako část komentáře.

• Na řádek, který obsahuje */ oddělovač, pokud je pouze bílá místa až */ oddělovač tohoto řádku je ignorováno.Jinak text na řádku až */ oddělovač je zpracován jako část komentáře, porovnávání pravidel popsaných v následujících odrážek.

• Pro řádky, po který začíná /** oddělovač, kompilátor vyhledává běžné vzorek na začátku každého řádku.Vzorek se může skládat z bílých volitelné a hvězdičku (*), následuje další volitelné prázdné místo.Pokud kompilátor najde společné vzorek na začátku každého řádku, který nezačíná /** oddělovač nebo */ oddělovač, ignoruje tohoto vzorku pro každý řádek.

Následující příklady ilustrují těchto pravidel.

• Pouze část následující komentář, který bude zpracován je řádek, který začíná <summary>.Formáty označení tři vyrábět stejného komentáře.

  /** <summary>text</summary> */ 
  
  /** 
  <summary>text</summary> 
  */ 
  
  /** 
   * <summary>text</summary> 
  */ 
  

• Kompilátor identifikuje společný vzorek "*" na začátku řádky druhé a třetí.Vzorek není součástí výstupu.

  /** 
   * <summary> 
   * text </summary>*/ 
  

• Kompilátor vyhledá žádný společný vzorek v následující komentář, protože není na třetím řádku druhý znak hvězdička.Proto je veškerý text na druhý a třetí řádky zpracován jako část komentáře.

  /** 
   * <summary> 
     text </summary>
  */ 
  

• Kompilátor vyhledá žádný vzorek v následující komentář dvou důvodů.Počet mezer před hvězdičku nejprve není konzistentní.Za druhé pátý řádek začíná kartě neodpovídá mezery.Proto je veškerý text z řádků dvě až pět zpracován jako část komentáře.

  /** 
    * <summary> 
    * text 
   *  text2 
      *  </summary> 
  */ 
  

Viz také

Referenční dokumentace

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

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

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

Koncepty

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