DocumentationCop

DocumentationCop inspects comments and XML documentation. It flags public procedures without XML documentation and constructs whose intent is not stated in code, such as a Commit without a comment explaining why. Ignoring these rules changes nothing at runtime; it leaves the next developer to reverse-engineer what the code is for.

Rules

IDTitleSeverityEnabledCode Fix
DC0001Commit requires a comment explaining whyInfo✓
DC0002Writing to a FlowField requires a comment explaining whyInfo✓
DC0003Empty statements should be removed or documentedInfo✓
DC0004Public procedures must include XML documentation commentsInfo✓
DC0005XML documentation must match the procedure signatureInfo✓
DC0006Internal procedures must include XML documentation commentsHidden✓
DC0007Public objects must include XML documentation commentsInfo✓
DC0008Internal objects must include XML documentation commentsHidden✓
DC0009Events must include XML documentation commentsHidden✓
DC0010Internal events must include XML documentation commentsHidden✓