Jeśli chcesz dodać komentarze referencyjne do swojego Kod XML, skorzystaj z tego samouczka krok po kroku, aby uzyskać wskazówki. Możesz dowiedzieć się, jak wykonać tę funkcję w ciągu zaledwie pięciu minut. Chociaż proces ten jest łatwy do ukończenia, przed rozpoczęciem należy jeszcze znać podstawowe informacje na temat komentarzy XML i ich użyteczności.
Dlaczego komentarze XML są przydatne
Komentarze w XML są prawie identyczne z komentarzami w HTML, ponieważ oba mają tę samą składnię. Korzystanie z komentarzy pozwala zrozumieć kod, który napisałeś lata wcześniej. Może również pomóc innemu programiście, który przegląda opracowany przez Ciebie kod, zrozumieć, co napisałeś. Krótko mówiąc, te komentarze zapewniają kontekst dla kodu.
Dzięki komentarzom możesz łatwo zostawić notatkę lub tymczasowo usunąć część kodu XML. Mimo że XML został zaprojektowany jako „samoopisujące się dane”, czasami może być konieczne pozostawienie komentarza XML.
Pierwsze kroki
Tagi komentarza składają się z dwóch części: części rozpoczynającej komentarz i części go kończącej. Aby rozpocząć, dodaj pierwszą część tagu komentarza:
Następnie napisz dowolny komentarz, jaki chcesz. Tylko upewnij się, że nie zagnieżdżasz komentarzy w innych komentarzach (więcej szczegółów znajdziesz w wskazówkach). Następnie zamkniesz tag komentarza:
-->
Przydatne porady
Dodając komentarze referencyjne do kodu XML, pamiętaj, że nie mogą one znajdować się na samej górze dokumentu. W XML tylko deklaracja XML może być na pierwszym miejscu:
Jak wspomniano powyżej, komentarze nie mogą być zagnieżdżane jeden w drugim. Musisz zamknąć swój pierwszy komentarz, zanim otworzysz drugi. Ponadto komentarze nie mogą występować w obrębie tagów, np.
.
Nigdy nie używaj dwóch myślników (--) nigdzie poza początkiem i końcem komentarzy. Wszystko w komentarzach jest skutecznie niewidoczne dla Parser XML, więc bądź bardzo ostrożny, aby to, co pozostało, było nadal aktualne i dobrze ukształtowane.
Zawijanie
Jeśli nadal masz pytania dotyczące dodawania komentarzy referencyjnych do kodu XML, możesz przeczytać książkę, aby uzyskać szczegółowy obraz działania tego procesu. Książki takie jak"Odniesienie programisty C# 5.0" Roda Stephensa może okazać się pomocne.