Dokumentowanie kod XML (Visual Basic)
W Visual Basic, można udokumentować kod przy użyciu XML
Komentarzy dokumentacji XML
Visual Basiczapewnia łatwy sposób, aby automatycznie utworzyć plik dokumentacji XML dla projektów.Automatycznie Generuj szkielet XML dla typów i członków, a następnie podaj podsumowania, opisowy dokumentacji dla każdego parametru i inne uwagi.Z odpowiednich instalacji dokumentacji XML jest automatycznie wysyłanego do pliku XML z taką samą nazwę jak projektu i rozszerzenie .xml.Aby uzyskać więcej informacji, zobacz /doc.
Plik XML można zużyte lub inny sposób manipulowania grupą obiektów jak XML.Ten plik znajduje się w tym samym katalogu co plik .exe lub .dll wyjściowy projektu.
Plik dokumentacji XML rozpoczyna się od '''.Przetwarzanie tych uwag ma pewne ograniczenia:
Dokumentacja musi być poprawnie sformułowany kod XML.Jeśli kod XML nie został dobrze uformowany, jest generowane ostrzeżenie i plików dokumentacji zawiera komentarz informujący, że wystąpił błąd.
Deweloperzy mają swobodę tworzenia własnego zestawu tagów.Istnieje zalecany zestaw znaczników (patrz "Sekcje pokrewne" w tym temacie).Niektóre znaczniki zalecane mają specjalne znaczenie:
<param> Tag jest używany do opisu parametrów.Używane, kompilator będzie sprawdzać, czy parametr istnieje i że wszystkie parametry są opisane w dokumentacji.Jeśli weryfikacja nie powiedzie się, kompilator generuje ostrzeżenie.
cref Atrybut może zostać dołączony do dowolny znacznik, aby podać odwołanie do elementu kodu.Kompilator sprawdza, czy istnieje element ten kod.Jeśli weryfikacja nie powiedzie się, kompilator generuje ostrzeżenie.Kompilator uwzględnia również dowolne Imports instrukcji podczas wyszukiwania z typem opisanym w cref atrybut.
<summary> Tag jest używany przez technologię IntelliSense w Visual Studio , aby wyświetlić dodatkowe informacje dotyczące typu lub członka.
Sekcje pokrewne
Szczegółowe informacje na temat tworzenia pliku XML z komentarzy dokumentacji zobacz następujące tematy: