StyleRules.md

February 11, 2021 ยท View on GitHub

Style Rules (DOC100-)

Rules related to the style of documentation comments.

IdentifierNameDescription
DOC100PlaceTextInParagraphsA <remarks> or <note> documentation element contains content which is not wrapped in a block-level element.
DOC101UseChildBlocksConsistentlyThe documentation for the element contains some text which is wrapped in block-level elements, and other text which is written inline.
DOC102UseChildBlocksConsistentlyAcrossElementsOfTheSameKindThe documentation for the element contains inline text, but the documentation for a sibling element of the same kind uses block-level elements.
DOC103UseUnicodeCharactersThe documentation contains an unnecessary or unrecognized HTML character entity.
DOC104UseSeeLangwordThe documentation contains a language keyword reference using <c>keyword</c> that can be converted to the preferred form <see langword="keyword"/>.
DOC105UseParamrefThe documentation contains a parameter reference using <c>name</c> that can be converted to the preferred form <paramref name="name"/>.
DOC106UseTypeparamrefThe documentation contains a type parameter reference using <c>T</c> that can be converted to the preferred form <typeparamref name="T"/>.
DOC107UseSeeCrefThe documentation contains a code element reference using <c>name</c> that can be converted to the preferred form <see cref="name"/>.
DOC108AvoidEmptyParagraphsThe documentation contains an empty paragraph element (<para/> or <p/>) used as a paragraph separator.