Reguły dokumentacji
Reguły dokumentacji obsługują pisanie dobrze udokumentowanych bibliotek przy użyciu poprawnych komentarzy dokumentacji XML dla zewnętrznych widocznych interfejsów API.
W tej sekcji
| Reguła | Opis |
|---|---|
| CA1200: Unikaj używania tagów cref z prefiksem | Atrybut cref w tagu dokumentacji XML oznacza "odwołanie do kodu". Określa, że tekst wewnętrzny tagu jest elementem kodu, takim jak typ, metoda lub właściwość. Unikaj używania cref tagów z prefiksami, ponieważ uniemożliwia kompilatorowi weryfikowanie odwołań. Zapobiega to również znajdowaniu i aktualizowaniu odwołań symboli podczas refaktoryzacji zintegrowanego środowiska projektowego (IDE) programu Visual Studio. |
Współpracuj z nami w serwisie GitHub
Źródło tej zawartości można znaleźć w witrynie GitHub, gdzie można również tworzyć i przeglądać problemy i żądania ściągnięcia. Więcej informacji znajdziesz w naszym przewodniku dla współtwórców.
Opinia
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź: https://aka.ms/ContentUserFeedback.
Prześlij i wyświetl opinię dla