Udostępnij za pośrednictwem

Reguły dokumentacji

  • Artykuł

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.