Ograniczniki znaczników dokumentacji (Przewodnik programowania w języku C#)

Komentarze doc XML wymaga ogranicznikami, które wskazują na kompilatorze gdzie komentarz dokumentacji rozpoczyna się i kończy.Za pomocą następujących rodzajów ograniczniki z dokumentacji XML, znaczniki:

• ///
  Jednowierszowo-ogranicznika.Jest to formularz, który jest przedstawione w dokumentacji, przykładów i używane przez Szablony projektu Visual C#.Jeśli znak białego odstępu po ogranicznik tego znaku nie znajduje się w danych wyjściowych XML.

  [!UWAGA]

  Visual Studio IDE ma funkcję o nazwie inteligentne edytowanie komentarzy wstawianą automatycznie <summary> i </summary> znaczniki i przenosi kursor w obrębie tych tagów, po wpisaniu /// ogranicznik w edytorze kodu.Dostęp do tej funkcji z Opcje, edytor tekstu, C#, formatowanie na stronach właściwości projektu.

• /** */
  Wielowierszowe ograniczników.

Istnieją pewne reguły formatowania należy wykonać, korzystając z /** */ ograniczników.

• W wierszu, który zawiera /** ogranicznika, jeśli reszta linii jest biały obszar wiersza nie jest przetwarzany na komentarze.Jeśli pierwszy znak w po /** ogranicznik jest białe miejsca, że znak białego odstępu jest ignorowany, a pozostałą część wiersza jest przetwarzane.W przeciwnym razie cały tekst wiersza po /** ogranicznik jest przetwarzany jako częoć komentarza.

• W wierszu, który zawiera */ ogranicznika, jeśli istnieje tylko białe miejsca do */ ogranicznika, że wiersz jest ignorowana.W przeciwnym razie tekst w wierszu do */ ogranicznik jest przetwarzany jako część komentarza, z zastrzeżeniem reguł dopasowania do wzorca, opisane w następujących punktora.

• Dla wierszy po zaczyna się od /** ogranicznika, kompilator szuka wspólnego wzorca na początku każdego wiersza.Wzorzec może składać się z opcjonalnych odstępu i gwiazdkę (*), a następnie więcej owiatło opcjonalne.Jeśli kompilator znajdzie wspólnego wzorca na początku każdego wiersza, który rozpoczyna się od /** ogranicznik lub */ ogranicznika, ignoruje ten wzorzec dla każdego wiersza.

Poniższe przykłady ilustrują tych zasad.

• Tylko część następujących komentarz, który będzie przetwarzany jest wiersz, który zaczyna się od <summary>.Formaty etykiet trzy produkcji tej samej uwagi.

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

• Kompilator identyfikuje wspólnej struktury "*" na początku linii w drugim i trzecim.Deseń nie znajduje się w danych wyjściowych.

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

• Kompilator stwierdza brak desenia wspólnej Poniższy komentarz, ponieważ drugi znak w trzecim wierszu nie jest gwiazdką.W związku z tym cały tekst w wierszach drugi i trzeci jest przetwarzany jako częoć komentarza.

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

• Kompilator stwierdzi brak desenia w następujących komentarz z dwóch powodów.Po pierwsze liczbę spacji przed gwiazdką nie jest spójny.Po drugie wiersz piąty zaczyna się kartę, która nie jest zgodna z spacje.W związku z tym całego tekstu od linii dwóch do pięciu jest przetwarzany jako częoć komentarza.

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

Zobacz też

Informacje

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

/doc (opcje kompilatora C#)

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

Koncepcje

Przewodnik programowania w języku C#