global-commenting
明確で長く有効なコードコメントを書く
チームはしばしば、古くなったり明らかなコードを繰り返したりするコメントを追加してしまいます。このスキルは、AI アシスタントが自明ではない判断を説明する最小限のコメントを書くよう導きます。
自分のエージェントでインストール
このリクエストをエージェントにコピーしてください。正規の Skill ページとマニフェストが含まれています。
Review the Skillstore skill "global-commenting" from https://skillstore.io/skills/devanb-global-commenting.md and its manifest at https://skillstore.io/api/skills/devanb-global-commenting/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.エージェントは引き続き計画を提示し、セキュリティポリシーで必要な確認を求める必要があります。
エージェントが読めるリソース
AI エージェント、クローラー、スクリプトがページ全体ではなく整理されたコンテキストを必要とする場合は、これらのリンクを使ってください。
テストする
「global-commenting」を使用しています。 サービスメソッドに、各代入と条件を言い換えているだけのコメントが複数含まれている。
期待される結果:
レビューでは冗長なコメントを削除し、その条件の背後にあるビジネスルールを説明する短い注記を 1 つだけ残します。
「global-commenting」を使用しています。 TypeScript 関数に、文脈のない複雑な日付ロジックがある。
期待される結果:
結果として、簡潔な TSDoc サマリーと、カレンダールールを説明するインラインコメントを 1 つ追加します。
「global-commenting」を使用しています。 プルリクエストで、一時的な移行回避策に関するコメントが追加されている。
期待される結果:
レビューでは、期限付きの表現を削除し、互換性チェックの安定した理由を文書化することを提案します。
セキュリティ監査
安全The static path traversal alert is a fixed Markdown link to a project standards document, not executable code or user-controlled file access. No prompt injection, data exfiltration, or malicious intent was found in SKILL.md.
リスク要因
📁 ファイルシステムへのアクセス (1)
このレポートを共有・引用
バージョン付き評価レポート、中立的なバッジ、埋め込みカード、引用を共有できます。Skillstore は証拠を報告しますが、この Skill が安全かどうかは判断しません。
レポートリンクをコピー
https://skillstore.io/skills/devanb-global-commenting/audits/10?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdownバッジ
[](https://skillstore.io/skills/devanb-global-commenting?utm_source=security_passport_badge)HTMLバッジ
<a href="https://skillstore.io/skills/devanb-global-commenting?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/devanb-global-commenting/security.svg" alt="Skillstore security assessment" loading="lazy"></a>埋め込みカード
<iframe src="https://skillstore.io/embed/skills/devanb-global-commenting.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>学術引用 (APA · BibTeX · CFF)
APA形式の引用
DevanB. (2026). global-commenting security audit report (audit version 10) [Author version unspecified]. Skillstore. https://skillstore.io/skills/devanb-global-commenting/audits/10BibTeX形式の引用
@techreport{devanb-devanb-global-commenting-2026,
author = {DevanB},
title = {global-commenting security audit report (audit version 10)},
institution = {Skillstore},
year = {2026},
number = {10},
url = {https://skillstore.io/skills/devanb-global-commenting/audits/10},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "global-commenting security audit report (audit version 10)"
version: "unspecified"
type: report
authors:
- name: "DevanB"
date-released: "2026-07-09"
url: "https://skillstore.io/skills/devanb-global-commenting/audits/10"
identifiers:
- type: other
value: "skillstore:devanb-global-commenting:audit:10"
description: "Skillstore immutable audit report identifier"
バリアントを比較
インストール可能なバリアント 2 件各作者のスキルは個別のインストール項目として維持されます。推奨バリアントは Skillstore の証拠で順位付けされます。
このバリアントが首位の理由
Skillstore スコア
このスコアの理由 証拠の信頼度: 高作成できるもの
既存のコードコメントを改善する
コードベース内のコメントをレビューし、長く有効な文脈を説明するものだけを残します。
Docblock を標準化する
最小限のコメントスタイルに合う PHPDoc、JSDoc、または TSDoc コメントを作成します。
コメントのノイズを減らす
コードの挙動を繰り返しているコメントを特定し、より明確な命名や構造を提案します。
これらのプロンプトを試す
このコードをレビューし、自明ではない判断を説明するコメントだけを追加してください。コードがすでに表している内容を繰り返すコメントは避けてください。
将来の保守担当者の助けになる箇所に、PHPDoc、JSDoc、または TSDoc コメントを追加してください。各コメントは簡潔にし、意図に焦点を当ててください。
この変更内の既存コメントをレビューしてください。古い、冗長、または一時的なコメントを指摘し、必要な場合のみ長く有効な置き換え案を提案してください。
より明確な名前や構造によってコメントが不要になる箇所を見つけてください。コメントは、自明ではないまま残るビジネスルールやアルゴリズムにのみ追加してください。
ベストプラクティス
- 名前や構造から理由が明確でない場合に、そのコードが存在する理由を説明します。
- コメントを追加する前に、より明確なコードを優先します。
- リリース日、一時的な注記、最近の変更履歴を避けることで、コメントを長く有効に保ちます。
回避
- すべての行にコメントしたり、明らかな制御フローを繰り返したりしないでください。
- ロジック変更後に古いコメントを残さないでください。
- 不明確な命名や過度に複雑な構造を隠すためにコメントを使わないでください。