code-comments-improve について
指定ファイルまたは最近変更されたファイルのコードコメントを確認し、必要な背景を補い、不明瞭、冗長、古くなったコメントを見直すスキルです。コードの言い換えではなく、判断理由や制約の説明を重視します。
主な機能
- 01コード構造と既存コメントを分析
- 02複雑な処理や境界ケースに注釈を追加
- 03不明瞭または古い注釈を修正
- 04冗長な注釈を削除
- 05判断理由や制約に焦点を当てる
活用シーン
- 01直感的でないアルゴリズムの採用理由を明確化
- 02前提条件と境界ケースの処理を記録
- 03実装変更後にコメントを更新
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/code-comments-improveを入力して読み込まれたか確認します。
詳細
指定されたファイル（指定がない場合は最近作業したファイル）のコードコメントを改善します。
-
コード構造と既存のコメントを分析する
- 指定されたファイルを読み込むか、最近変更されたファイルを特定します
- 関数、クラス、複雑なロジックのブロックを特定します
- 既存のコメントの明確さと有用性を評価します
-
有益な箇所に的を絞ってインラインコメントを追加する：
- コードだけでは意図が分かりにくい複雑なビジネスロジック
- 直感的でないアルゴリズム上の選択や最適化
- 重要な前提や制約
- エッジケースとその処理方法
- 外部システムとの連携箇所
-
既存のコメントを改善する：
- 冗長すぎる表現や専門用語を簡潔にします
- コードを言い換えただけの冗長なコメントを削除します
- 現在の実装に合っていない古いコメントを修正します
- 適切な場合は、WHAT を説明するコメントを WHY を説明するコメントに変更します
-
WHAT ではなく WHY を重視する：
- ビジネス上の理由や判断の根拠を説明します
- 別の方法ではなく、この方法を選んだ理由を記録します
- 直感的でない要件や制約を明確にします
- 命名から明らかなコードへのコメントは避けます
-
コメントのガイドライン：
- コメントは簡潔で要点を押さえたものにします
- 明確で平易な表現を使います
- コードから読み取れる内容に加えて、役立つ情報を記載します
- 関連するコードの近くに配置します
- プロジェクト内で一貫したコメントのスタイルを使います
出力：改善したコメントを含むコードを提示し、コメントを追加または変更した理由をそれぞれ説明します。
コメント
Markdown 対応