Docs: Improve inline comment guidance#16998
Open
kevinjqliu wants to merge 1 commit into
Open
Conversation
kevinjqliu
force-pushed
the
kevinjqliu/codex-agents-comment-guidance
branch
from
2b65e78 to
15f3fdc
Compare
Generated-by: GPT-5 Codex
kevinjqliu
force-pushed
the
kevinjqliu/codex-agents-comment-guidance
branch
from
15f3fdc to
adf6cd1
Compare
kevinjqliu
changed the title
manuzhang
reviewed
Jun 29, 2026
| - Javadoc describes the function or purpose of a class or method, not the implementation. Only describe what callers need to use the component, as though it were defined by an interface. Don't leak implementation details — over-documenting creates churn when the implementation changes. | ||
| - Magic numbers should be named constants. No personal pronouns in comments. Comments should explain non-obvious intent or constraints; don't restate what the code already says. | ||
| - Javadoc describes the function or purpose of a class or method, not the implementation. For public APIs, keep it brief and describe only what callers need to use the component, as though it were defined by an interface. Don't leak implementation details. | ||
| - Comments and Javadocs should describe the current behavior or contract, not how it changed over time. |
Member
There was a problem hiding this comment.
I like this one. Sometimes I wish it can forget quickly.
wombatu-kun
approved these changes
Jun 29, 2026
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
4 participants
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.
Summary
Validation
git diff --check origin/main...HEADAI Disclosure