Pravidla dokumentace
Pravidla dokumentace podporují psaní dobře zdokumentovaných knihoven prostřednictvím správného použití komentářů k dokumentaci XML pro externě viditelná rozhraní API.
V této části
Pravidlo | Popis |
---|---|
CA1200: Nepoužívejte značky cref s předponou | Atribut cref ve značce dokumentace XML znamená "odkaz na kód". Určuje, že vnitřní text značky je prvek kódu, například typ, metoda nebo vlastnost. cref Nepoužívejte značky s předponami, protože to brání kompilátoru v ověřování odkazů. Také brání integrovanému vývojovému prostředí sady Visual Studio v hledání a aktualizaci těchto odkazů na symboly během refaktoringu. |
Spolupracujte s námi na GitHubu
Zdroj tohoto obsahu najdete na GitHubu, kde můžete také vytvářet a kontrolovat problémy a žádosti o přijetí změn. Další informace najdete v našem průvodci pro přispěvatele.
Váš názor
https://aka.ms/ContentUserFeedback.
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu:Odeslat a zobrazit názory pro