Repository navigation
docs: align xml documentation and code comment policy - #151
Merged
Merged
Conversation
AGENTS.md said no docstrings or comments while CONTRIBUTING.md asked for XML documentation on public APIs. XML documentation comments on public APIs are now expected everywhere; inline code comments that explain code remain disallowed. No code or behaviour change. Refs #146 Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
7 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What / why
AGENTS.md said "Don't add docstrings or comments unless explicitly asked" while CONTRIBUTING.md said to write XML docs for public APIs. Decision (per #146 item F): XML documentation comments (
///) on public API are expected; inline code comments (//,/* */) explaining code are not.Files: AGENTS.md, CONTRIBUTING.md, .claude/rules/csharp.md, .kimi/skills/csharp-conventions/SKILL.md (one line each, minimal wording).
Build enforcement (reality check)
Directory.Build.props sets
GenerateDocumentationFile=trueandNoWarn=1591, so XML docs are generated but missing docs on public members are NOT enforced (CS1591 suppressed). No CS1591/SA1600 entries in .editorconfig. About 482 of ~685 files declaring public types already contain///. The policy is therefore a convention, not a build gate; no build config was changed. No XML docs added in this PR.Evidence
Docs only; no code or tests changed. Red/green: n/a.
Behaviour change
None. No release (docs:).
Refs #146
🤖 Generated with Claude Code