writing-no-comments について
コーディングエージェント向けに、コードの新規作成や編集時はコメントを避け、変更していない行の既存コメントは残すルールを定めるスキルです。意図は名前、型、アサーション、テストで表す方針です。
主な機能
- 01新規・編集コードでのコメント回避
- 02コード構造による理由の表現
- 03未変更行のコメント保持
- 04コードを書くサブエージェントへのルール共有
- 05ユーザーの依頼に応じたコメント追加
活用シーン
- 01コメントを抑えてコードを編集
- 02コードを書くサブエージェントの指針
- 03差分内のコメント変更を確認
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/writing-no-commentsを入力して読み込まれたか確認します。
同梱ファイルagents/openai.yamlshared/code-comments.md
詳細
コメントを書かない
- 書いたり編集したりするコードには、コードコメントのルールで認められている場合を除き、コメントを追加しないでください。迷った場合は、追加しないでください。
- 理由は、名前、型、アサーション、またはテストに示してください。どれにも示せない場合は、コミットメッセージまたは返信に記載してください。
- テストやスクリプトには、手順やフェーズを説明する記述を入れないでください。
- 変更しない行のコメントはそのまま残してください。変更によって誤りになったコメントは修正するか削除してください。
- コードを書くサブエージェントにもこのルールを伝え、受け入れる前にその差分を確認してください。
- ユーザーから求められたコメントは、依頼どおりに追加してください。
コメント
Markdown 対応