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.