Dokumentationsregler

Dokumentationsregler stöder skrivning av väldokumenterade bibliotek genom korrekt användning av XML-dokumentationskommentar för externt synliga API:er.

Innehåll i det här avsnittet

Regel

Beskrivning

CA1200: Undvik att använda cref-taggar med ett prefix

Cref-attributet i en XML-dokumentationstagg betyder "kodreferens". Den anger att den inre texten i taggen är ett kodelement, till exempel en typ, metod eller egenskap. Undvik att använda cref taggar med prefix eftersom det förhindrar att kompilatorn verifierar referenser. Det förhindrar också att Visual Studio Integrated Development Environment (IDE) hittar och uppdaterar dessa symbolreferenser under refaktoriseringar.