Dokumentációs szabályok

  • Cikk

A dokumentációs szabályok támogatják a jól dokumentált kódtárak írását a külsőleg látható API-k xml-dokumentációs megjegyzéseinek helyes használatával.

A szakasz tartalma

Szabály Description
CA1200: Ne használjon cref-címkéket előtaggal Az XML-dokumentációs címkében szereplő cref attribútum "kódhivatkozást" jelent. Meghatározza, hogy a címke belső szövege kódelem, például típus, metódus vagy tulajdonság. Kerülje a címkék előtagokkal való használatát cref , mert megakadályozza, hogy a fordító ellenőrizze a hivatkozásokat. Azt is megakadályozza, hogy a Visual Studio integrált fejlesztési környezete (IDE) megtalálja és frissítse ezeket a szimbólumhivatkozásokat az újrabontások során.