Ograniczniki znaczników dokumentacji Visual C++
Korzystanie z dokumentacji tagi wymaga ogranicznikami, które wskazują na kompilator, gdzie rozpoczyna się i kończy w komentarz dokumentacji.
Można używać następujących rodzajów ograniczników z dokumentacji XML, znaczniki:
///
Jest to formularz, który jest pokazany w przykładach w dokumentacji i używane przez szablonów projektu Visual C++./** */
Są to wielowierszowy ograniczników.
Istnieje, niektóre elementy formatowania reguł podczas korzystania z /** */ ograniczników:
Dla wiersza, który zawiera /** ogranicznik, jeśli reszta linii jest odstępu, wiersz nie jest przetwarzany za komentarze.Jeśli pierwszy znak ma odstępu, że znak odstępu jest ignorowany, a pozostałą część wiersza jest przetwarzany.W przeciwnym razie cały tekst wiersza po /** ogranicznik jest przetwarzany jako część komentarza.
Dla wiersza, który zawiera */ ogranicznik, jeśli istnieje tylko odstępu do */ ogranicznik, że linia jest ignorowana.W przeciwnym razie tekst w wierszu do */ ogranicznik jest przetwarzany jako część komentarza, z zastrzeżeniem zasady dopasowania do wzorca, określone w następujących punktora.
Dla wierszy po jednej, która zaczyna się od /** ogranicznik, kompilator szuka wspólnego wzorca na początku każdego wiersza, która składa się z opcjonalnych odstępu i znak gwiazdki (*), a następnie opcjonalne białe miejsca.Jeśli kompilator znajdzie wspólny zbiór znaków na początku każdego wiersza, zignoruje ten deseń dla wszystkich wierszy po /** , ewentualnie w tym wierszu, który zawiera ogranicznik */ ogranicznik.
Kilka przykładów:
Tylko część Poniższy komentarz, który będzie przetwarzany jest linia, która zaczyna się od <summary>.Następujące formaty etykiet dwóch opracuje tych samych komentarzy:
/** <summary>text</summary> */ /** <summary>text</summary> */Kompilator stosuje się wzór "*" ignoruje na początku drugiego i trzeciego wierszy.
/** * <summary> * text </summary>*/Kompilator stwierdzi brak desenia w tym komentarzu, ponieważ nie ma żadnych gwiazdki w drugim wierszu.W związku z tym, cały tekst w wierszu drugim i trzecim do chwili obecnej */, będzie przetwarzana jako część komentarza.
/** * <summary> text </summary>*/Kompilator stwierdzi brak desenia w tym komentarzu z dwóch powodów.Po pierwsze nie istnieje żaden z wierszy, rozpoczynającą się od spójne liczbę spacji przed gwiazdką.Po drugie wiersz piąty zaczyna się kartę, która jest niezgodna z spacji.W związku z tym, cały tekst z drugiego wiersza, aż do */ będzie przetwarzana jako część komentarza.
/** * <summary> * text * text2 * </summary> */