From de3f1d134d2b7e2048237f446cb2f18423e6c306 Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Sun, 17 May 2026 11:25:05 +0200 Subject: [PATCH] Rules: Update comment-rules for multi-paragraph descriptions Signed-off-by: Michael Mayer --- .claude/rules/code-comments.md | 2 +- AGENTS.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.claude/rules/code-comments.md b/.claude/rules/code-comments.md index fa294935a..3eb8602e1 100644 --- a/.claude/rules/code-comments.md +++ b/.claude/rules/code-comments.md @@ -5,7 +5,7 @@ Doc comments for packages and exported identifiers must be complete sentences th A doc comment is **required** for every function (including unexported helpers), as well as for every non-trivial Vue `methods:` / `computed:` / watcher: - Keep comments **compact** and default to one line for WHAT in the format `// Name does X.`. Skip trivial getters (`isOpen: () => this.open`). - Add up to three follow-up lines (`// …`) only when the WHY is non-obvious: a hidden invariant, a workaround that would otherwise be undone by a future cleanup, a contract a reader can't infer from the code. -- If readers can derive the WHY from the function body or a nearby line, leave it out. Multi-paragraph comments belong in `specs/`, package `README.md` files, or issue descriptions — never in the source itself. +- If readers can derive the WHY from the function body or a nearby line, leave it out. Multi-paragraph descriptions belong in `specs/`, package `README.md` files, or GitHub issues — never in the source itself. - For short examples in comments, indent code instead of using backticks. > **Don't include in code comments:** Issue / PR numbers, "previously…" history, alternatives considered, what the function used to do, references to old commits, names of subsequent reviewers, or any narrative that names the change rather than the steady-state behavior. That context belongs in commit messages, specs, or handover notes. diff --git a/AGENTS.md b/AGENTS.md index d59c3681b..ddb37b1de 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -111,7 +111,7 @@ Doc comments for packages and exported identifiers must be complete sentences th A doc comment is **required** for every function (including unexported helpers), as well as for every non-trivial Vue `methods:` / `computed:` / watcher: - Keep comments **compact** and default to one line for WHAT in the format `// Name does X.`. Skip trivial getters (`isOpen: () => this.open`). - Add up to three follow-up lines (`// …`) only when the WHY is non-obvious: a hidden invariant, a workaround that would otherwise be undone by a future cleanup, a contract a reader can't infer from the code. -- If readers can derive the WHY from the function body or a nearby line, leave it out. Multi-paragraph comments belong in `specs/`, package `README.md` files, or issue descriptions — never in the source itself. +- If readers can derive the WHY from the function body or a nearby line, leave it out. Multi-paragraph descriptions belong in `specs/`, package `README.md` files, or GitHub issues — never in the source itself. - For short examples in comments, indent code instead of using backticks. > **Don't include in code comments:** Issue / PR numbers, "previously…" history, alternatives considered, what the function used to do, references to old commits, names of subsequent reviewers, or any narrative that names the change rather than the steady-state behavior. That context belongs in commit messages, specs, or handover notes.