Nuta
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować się zalogować lub zmienić katalog.
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować zmienić katalogi.
Reguły dokumentacji obsługują pisanie dobrze udokumentowanych bibliotek poprzez poprawne użycie komentarzy dokumentacyjnych XML dla zewnętrznie widocznych interfejsów API.
W tej sekcji
| Reguła | Opis |
|---|---|
| CA1200: Unikaj używania tagów cref z prefiksem | Atrybut o nazwie 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 tagów cref z prefiksami, ponieważ uniemożliwia kompilatorowi weryfikowanie odwołań. Zapobiega to również zintegrowanemu środowisku programistycznemu (IDE) programu Visual Studio przed znajdowaniem i aktualizowaniem odwołań do symboli podczas refaktoryzacji. |
Współpracuj z nami na GitHub
Źródło tej treści można znaleźć na GitHubie, gdzie można także tworzyć i przeglądać problemy oraz pull requesty. Więcej informacji znajdziesz w naszym przewodniku dla współautorów.
