Documentation & Comments (AV2300)

Edit this page

Documentation & Comments (AV2300)

Rule Guideline
AV2301 Write all comments and XML documentation in US English.
AV2305 Document every public, protected, and internal type and member with XML doc comments.
AV2306 Write documentation for other developers who don’t have access to the source code.
AV2308 Document the purpose of a member (the why and what), not its implementation (the how).
AV2310 Avoid inline comments; replace complex blocks with well-named methods instead.
AV2316 Only write comments to explain non-obvious algorithms or significant design decisions.
AV2318 Don’t use // TODO comments as a task tracker; use a proper issue tracking system.