Documentation rules

Documentation rules support writing well-documented libraries through the correct use of XML documentation comments for externally visible APIs.

In this section

Rule Description

CA1200: Avoid using cref tags with a prefix The cref attribute in an XML documentation tag means "code reference". It specifies that the inner text of the tag is a code element, such as a type, method, or property. Avoid using cref tags with prefixes, because it prevents the compiler from verifying references. It also prevents the Visual Studio integrated development environment (IDE) from finding and updating these symbol references during refactorings.

Rule	Description
CA1200: Avoid using cref tags with a prefix	The cref attribute in an XML documentation tag means "code reference". It specifies that the inner text of the tag is a code element, such as a type, method, or property. Avoid using `cref` tags with prefixes, because it prevents the compiler from verifying references. It also prevents the Visual Studio integrated development environment (IDE) from finding and updating these symbol references during refactorings.

Maklum balas

Adakah halaman ini membantu?

Last updated on 2021-09-15

Kongsi melalui

Documentation rules

In this section

Maklum balas

Sumber tambahan