コードコメントは古くなったり、当たり前のことを述べるだけになりがちです。このスキルは、複雑なロジックを説明し、保守負担を軽減する、意味のある時代に左右されないコメントを書くのに役立ちます。
スキルZIPをダウンロード
Claudeでアップロード
設定 → 機能 → スキル → スキルをアップロードへ移動
オンにして利用開始
テストする
「global-commenting」を使用しています。 この複雑な日付計算関数にコメントを付けるのを手伝ってください
期待される結果:
- 次を追加することを検討してください:「週末と祝日を考慮して、次の営業日を計算します」
- アルゴリズムを説明:「whileループを使用して週末をスキップし、祝日配列と照合します」
- エッジケースを文書化:「締切時刻前にすでに営業日である場合は、同じ日を返します」
「global-commenting」を使用しています。 私のAPIエンドポイントハンドラーをレビューしてください
期待される結果:
- 変数名を変更することで削除できる明白なコメントを特定
- 複雑な検証ロジックに対するコメントを提案
- ビジネスルールが変更されたときに古くなる可能性のあるコメントにフラグを付ける
「global-commenting」を使用しています。 ユーティリティライブラリにドキュメントを追加してください
期待される結果:
- パラメータ型を含むエクスポートされた関数のJSDocヘッダーを作成
- 複雑な関数の文書文字列に例を追加
- 副作用と戻り値の期待値を明確に文書化
セキュリティ監査
安全This skill contains only documentation files (SKILL.md and skill-report.json) with no executable code, network calls, or filesystem operations. All 17 static findings are FALSE POSITIVES caused by the scanner misidentifying SHA256 hashes as cryptographic algorithms and relative path references as path traversal. The skill is purely a documentation/prompt-based guidance system.
リスク要因
🌐 ネットワークアクセス (1)
📁 ファイルシステムへのアクセス (4)
品質スコア
作れるもの
より良いPHPDocコメントを書く
適切なPHPDoc構文でPHPクラス、メソッド、複雑な配列構造を文書化するガイダンスを取得
JSDocドキュメントを改善
関数や複雑なロジックに対して意味のあるJSDocコメントをいつ、どのように書くかを学習
コメントの品質をレビュー
既存のコメントの関連性、正確性、よりクリアなコードにリファクタリングすべきかどうかを評価
これらのプロンプトを試す
Help me write a comment for this sorting function that explains why we are using this specific algorithm instead of the built-in sort
Write PHPDoc comments for this service class including the purpose, main responsibilities, and any important implementation details
Review these comments and suggest which ones can be removed by improving the code clarity instead
Help me write a comment that explains this business rule and why it is implemented this way
ベストプラクティス
- 「何を」ではなく「なぜ」を説明するコメントを書く - コードはすでに何をするかを示している
- 一時的な修正や最近の変更への言及を避けることで、コメントを時代に左右されないものにする
- 説明的なコメントを追加するよりも、明確さのためにコードをリファクタリングすることを優先
回避
- 「カウンタをインクリメント」のような明白なコメントを書かない - コードはすでに明確
- 削除する代わりにコードをコメントアウトしない - 履歴にはバージョン管理を使用
- 不明確なコードの言い訳としてコメントを使用しない - まずコードを修正