Sdílet prostřednictvím


Pravidla dokumentace

Pravidla dokumentace podporují psaní dobře zdokumentovaných knihoven prostřednictvím správného použití komentářů dokumentace 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. Nepoužívejte značky cref s předponami, protože brání kompilátoru v ověřování odkazů. Brání také integrovanému vývojovému prostředí (IDE) sady Visual Studio v hledání a aktualizaci těchto odkazů na symboly během refaktoringu.