trim-comments

コメントを簡潔にする

コメントの冗長さを減らします。normal（デフォルト）では、意味を保ちながら長ったらしいコメントを短くします。短くしても、難解にはしません。削除はしません。aggressiveでは、ほぼすべてのコメントを削除します。ユーザーが「aggressive」「strip」「remove all」と指示した場合にのみ、aggressive を使用してください。

常に次の2つのルールを守ってください。

• コメントのみを編集し、実行可能なコードの行は決して変更しません。
• 対象範囲： ユーザーがファイルを指定していない限り、変更されたコードだけを対象にします。まず未コミットのローカル差分、次に PR の差分を対象にします。コードベース全体に手を加えるのは、明示的に依頼された場合に限ります。

各モードの動作

COMMENT TYPE                          NORMAL              AGGRESSIVE
─────────────────────────────────────────────────────────────────────
Restatement (// create user)          shorten             DELETE
Narration (// loop over users)        shorten             DELETE
Echo docstring (Gets name)            shorten             DELETE
Plain why-comment                     keep (shortened)    DELETE
TODO / FIXME / HACK                   keep                DELETE
Doc comment (godoc etc.)              keep (shortened)    stub if lint needs it, else DELETE
Unusual workaround / gotcha           keep (shortened)    KEEP but trim shorter
─────────────────────────────────────────────────────────────────────
Tooling directives (//go:generate…)   never touch         never touch
License / copyright headers           never touch         never touch

注意事項

• 特殊な回避策とは、わかりにくい落とし穴、回避しているバグ、「これをしないと別の動作が壊れる」という注記のことです。aggressive でもこれらは残しますが、理由が伝わる最短の形にします。
• ツール関連の指示（//go:generate、//go:embed、# noqa、# type: ignore、// eslint-disable、// @ts-expect-error、// nolint）とライセンスヘッダーは、コメントのように見えてもノイズではありません。削除すると動作が変わったり、法的な影響が生じたりします。どちらのモードでも決して変更しないでください。