Documentation Rules

Jump to bottom Edit New page

Christophe HEISER edited this page Aug 15, 2015 · 2 revisions

<title>Documentation Rules</title> <script src="script/helpstudio.js" type="text/javascript"></script> <script src="script/StandardText.js" type="text/javascript"></script>

<script type="text/javascript">WritePageTop(document.title);</script>

Rules which verify the content and formatting of code documentation.

SA1600: ElementsMustBeDocumented

SA1601: PartialElementsMustBeDocumented

SA1602: EnumerationItemsMustBeDocumented

SA1603: DocumentationMustContainValidXml

SA1604: ElementDocumentationMustHaveSummary

SA1605: PartialElementDocumentationMustHaveSummary

SA1606: ElementDocumentationMustHaveSummaryText

SA1607: PartialElementDocumentationMustHaveSummaryText

SA1608: ElementDocumentationMustNotHaveDefaultSummary

SA1609: PropertyDocumentationMustHaveValue

SA1610: PropertyDocumentationMustHaveValueText

SA1611: ElementParametersMustBeDocumented

SA1612: ElementParameterDocumentationMustMatchElementParameters

SA1613: ElementParameterDocumentationMustDeclareParameterName

SA1614: ElementParameterDocumentationMustHaveText

SA1615: ElementReturnValueMustBeDocumented

SA1616: ElementReturnValueDocumentationMustHaveValue

SA1617: VoidReturnValueMustNotBeDocumented

SA1618: GenericTypeParametersMustBeDocumented

SA1619: GenericTypeParametersMustBeDocumentedPartialClass

SA1620: GenericTypeParameterDocumentationMustMatchTypeParameters

SA1621: GenericTypeParameterDocumentationMustDeclareParameterName

SA1622: GenericTypeParameterDocumentationMustHaveText

SA1623: PropertySummaryDocumentationMustMatchAccessors

SA1624: PropertySummaryDocumentationMustOmitSetAccessorWithRestricedAccess

SA1625: ElementDocumentationMustNotBeCopiedAndPasted

SA1626: SingleLineCommentsMustNotUseDocumentationStyleSlashes

SA1627: DocumentationTextMustNotBeEmpty

SA1628: DocumentationTextMustBeginWithACapitalLetter

SA1629: DocumentationTextMustEndWithAPeriod

SA1630: DocumentationTextMustContainWhitespace

SA1631: DocumentationTextMustMeetCharacterPercentage

SA1632: DocumentationTextMustMeetMinimumCharacterLength

SA1633: FileMustHaveHeader

SA1634: FileHeaderMustShowCopyright

SA1635: FileHeaderMustHaveCopyrightText

SA1636: FileHeaderCopyrightTextMustMatch

SA1637: FileHeaderMustContainFileName

SA1638: FileHeaderFileNameDocumentationMustMatchFileName

SA1639: FileHeaderMustHaveSummary

SA1640: FileHeaderMustHaveValidCompanyText

SA1641: FileHeaderCompanyNameTextMustMatch

SA1642: ConstructorSummaryDocumentationMustBeginWithStandardText

SA1643: DestructorSummaryDocumentationMustBeginWithStandardText

SA1644: DocumentationHeadersMustNotContainBlankLines

SA1645: IncludedDocumentationFileDoesNotExist

SA1646: IncludedDocumentationXPathDoesNotExist

SA1647: IncludeNodeDoesNotContainValidFileAndPath

SA1648: InheritDocMustBeUsedWithInheritingClass

SA1649: FileHeaderFileNameDocumentationMustMatchTypeName

SA1650: ElementDocumentationMustBeSpelledCorrectly