global-commenting
クリーンで焦点の合ったコードコメントを書く
También disponible en: DevanB
不十分または古くなったコメントは混乱と技術的負債を生みます。このスキルは、なぜその判断が行われたのかを説明するコメントを書くための明確なガイドラインを提供し、開発者が時間が経っても有効な自己文書化コードを作成できるよう支援します。
Descargar el ZIP de la skill
Subir en Claude
Ve a Configuración → Capacidades → Skills → Subir skill
Activa y empieza a usar
Pruébalo
Usando "global-commenting". Write a comment for this sorting function
Resultado esperado:
- マージソートではなくクイックソートが選ばれた理由を説明する（インプレースのメモリ使用）
- ピボット選択の戦略を記述する
- 処理しているエッジケースに言及する
- クイックソートとは何かの説明は省く - 読者はアルゴリズムを知っている
Usando "global-commenting". Should I add a comment here?
Resultado esperado:
- 命名と構造からコードの意図が明確かを確認する
- 文脈から理由が明確でない場合にのみコメントを追加する
- まずコードを自己説明的にするためのリファクタリングを検討する
- コードが示している内容を繰り返すだけのコメントは避ける
Usando "global-commenting". Review these comments for improvement
Resultado esperado:
- なぜではなく何を記述しているコメントを指摘する
- 変更により古くなるコメントを特定する
- 自明または冗長なコメントの削除を提案する
- 正確さのために更新が必要なコメントを示す
Auditoría de seguridad
SeguroPure documentation skill containing only markdown files with commenting guidelines. No executable code, network access, filesystem operations, or command execution. All 24 static findings are false positives from over-aggressive pattern matching on Git metadata, documentation references, and benign terminology.
Factores de riesgo
🌐 Acceso a red (1)
📁 Acceso al sistema de archivos (4)
Puntuación de calidad
Lo que puedes crear
明確なコメントを書く
コードベース内の複雑なロジックや自明ではない判断を説明する有意義なコメントを追加します。
ドキュメントの改善
コードレビュー中に既存のコメントを見直し、明確さと適切さを改善します。
APIのドキュメント化
確立された標準に従って一貫したドキュメント文字列やAPIコメントを作成します。
Prueba estos prompts
このアプローチが選ばれた理由を説明する明確なコメントをこの関数に追加してください。ビジネスロジックと自明ではない判断に焦点を当ててください。
これらのコメントをレビューし、古いもの、冗長なもの、またはより明確なコードや変数名に置き換えられるものを指摘してください。
アルゴリズムのアプローチと、それが代替案よりもこの問題をうまく解決する理由を説明するコメントを書いてください。
命名と構造によってこのコードをより自己説明的にする方法を提案し、どこにコメントがなお価値を持つかを示してください。
Mejores prácticas
- コードが存在する理由を説明し、何をしているかは説明しない
- 過剰なコメントよりも明確な命名と構造を優先する
- コメントは長期的に有効に保つ - 一時的な修正の記録は避ける
Evitar
- カウンターのインクリメントのような自明なコードへのコメント
- コメントアウトされたブロックでコードを無効化する
- コードの意図ではなく最近の変更内容を説明するコメントを書く