docs: improve code comment guidelines for AI agents #20952
Merged
Conversation
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
Add comprehensive commenting standards to CLAUDE.md focusing on: - Proper sentence structure with punctuation - Explaining rationale rather than describing code - 80-character line width with natural wrapping These guidelines help AI agents write more professional and maintainable comments that align with project standards. --- 🤖 This change was written by Claude Sonnet 4.5 Thinking using [mux](https://github.com/coder/mux) and reviewed by a human 🏂
mafredri
commented
Nov 26, 2025
Replace OAuth2/AsSystemRestricted example with a clearer timeout example that better demonstrates the difference between why-focused vs what-focused comments and proper formatting vs awkward one-sentence-per-line style.
ThomasK33
approved these changes
Nov 26, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR enhances the CLAUDE.md document with comprehensive guidelines for writing better code comments, specifically targeted at AI agents and LLM-generated code.
Changes
Example
The guidelines include before/after examples showing the difference between well-formatted, meaningful comments and poorly written ones.
Impact
These standards will help ensure AI-generated code includes professional, maintainable comments that align with project conventions.
🤖 This change was written by Claude Sonnet 4.5 Thinking using mux and reviewed by a human 🏂