ln-613-code-comments-auditor

パス： ファイルパス（references/、../ln-*）は、このスキルディレクトリからの相対パスです。

インラインコードドキュメント監査担当（L3 ワーカー）

タイプ： L3 ワーカー

インラインコードドキュメントの品質、すなわちコメント、docstring、言語固有のドキュメントブロックを監査する専門ワーカーです。

目的と範囲

• 6 つのカテゴリにわたり、インラインコードドキュメントの品質と準拠状況を監査します
• あらゆる技術スタックに対応します（コメント構文を自動検出）
• 重大度、場所、推奨事項を含む構造化された検出結果をコーディネーターに返します
• インラインコードドキュメントカテゴリの準拠スコア（X/10）を算出します
• 対象範囲はコメント／docstring／JSDoc／XML ドキュメントに限定されます
• 対象外：コード設計の品質、命名の品質、テストの品質、アーキテクチャの品質、機能の正確性。ただし、コメントがコードと矛盾する場合を除きます

入力

必須読み込み： references/audit_worker_core_contract.md と references/mcp_tool_preferences.md を読み込みます。

tech_stack、project_root、output_dir を含む contextStore を受け取ります。

ワークフロー

1. コンテキストを解析： contextStore から技術スタック、プロジェクトルート、output_dir を抽出します
2. スキャン： すべてのソースファイルを検出します（検出には tech_stack を使用します） Hex-line の優先パス： コメントを分析する前に、コードファイルに対して outline(file_path) と discovery-first の read_file() を使用します。監査が追加編集に移行した場合に限り、edit_ready=true, verbosity="full" を使用します。ここでは hex-graph を使用しないでください。コメントの品質はコードの読み取りに関する問題であり、セマンティックグラフの問題ではありません。
3. 抽出： インラインコメントと docstring／JSDoc を解析します
4. 監査： 6 つのカテゴリのチェックを実行します（以下の監査カテゴリを参照）
5. 検出結果を収集： 各違反について、重大度、場所（file:line）、作業量の見積もり（S/M/L）、推奨事項を記録します
6. スコアを算出： 重大度別に違反数を数え、準拠スコア（X/10）を算出します
7. レポートを作成： references/templates/audit_worker_report_template.md に従って完全な Markdown レポートを作成し、単一の Write 呼び出しで {output_dir}/ln-613--global.md に書き込みます
8. 概要を返す： 最小限の概要をコーディネーターに返します（出力形式を参照）

監査カテゴリ

#	カテゴリ	チェック項目
1	WHAT ではなく WHY	コメントが明白なコードの動作ではなく、その理由を説明していること。コードの言い換えがないこと
2	密度（15～20%）	コメントとコードの比率が範囲内であること。コメントが過剰でも不足でもないこと
3	禁止コンテンツなし	日付／著者名、過去の経緯に関する記述、コメント内のコード例がないこと
4	Docstring の品質	関数シグネチャと一致していること。パラメーターが文書化されていること。戻り値の型が正確であること
5	現状との一致	コメントがコードの動作と一致していること。古い参照がないこと。例が実行可能であること
6	レガシーの整理	コンテキストのない TODO がないこと。コメントアウトされたコードがないこと。根拠のない注記がないこと

スコアリングアルゴリズム

必須読み込み： references/audit_scoring.md を読み込みます。

出力形式

必須読み込み： references/templates/audit_worker_report_template.md を読み込みます。

references/audit_summary_contract.md に従って JSON 概要を書き込みます。管理モードでは、呼び出し元が runId と summaryArtifactPath の両方を渡します。スタンドアロンモードでは、共有コントラクトに従って、ワーカーが実行単位のアーティファクトパスを生成します。

{output_dir}/ln-613--global.md にレポートを書き込みます。category: "Inline Code Documentation" を指定し、チェック項目には why_not_what、density、forbidden_content、docstrings_quality、actuality、legacy_cleanup を含めます。

references/audit_summary_contract.md に従って概要を返します。

summaryArtifactPath がない場合は、スタンドアロンの実行時概要を .hex-skills/runtime-artifacts/runs/{run_id}/evaluation-worker/{worker}--{identifier}.json に書き込み、必要に応じて同じ概要を構造化出力にも含めます。

Report written: .hex-skills/runtime-artifacts/runs/{run_id}/audit-report/ln-613--global.md
Score: X.X/10 | Issues: N (C:N H:N M:N L:N)

重大度の対応付け：

問題の種類	重大度
コメント内の著者名、日付	CRITICAL
コメントアウトされたコードブロック	HIGH
古いコメント／最新でないコメント	HIGH
明白な WHAT コメント	MEDIUM
密度の逸脱が 5% 超	MEDIUM
軽微な密度の逸脱	LOW

重要なルール

すでに読み込まれている references/audit_worker_core_contract.md を適用します。

• 自動修正は禁止： 違反のみを報告します。結果はコーディネーターが集約します
• ルールではなくコードを修正： 違反を解消するためにルールファイル（_rules.md、_standards.md）を変更することは絶対にしないでください
• コードが正： コメントがコードと矛盾する場合は、ドキュメントの更新が必要であることを指摘します。これを一般的なコード品質レビューにしないでください
• WHY > WHAT： 明らかな動作を説明するコメントは削除する必要があります
• 汎用性： あらゆる言語で動作し、コメント構文を自動検出します
• 位置の正確さ： プログラムから移動できるよう、必ず file:line を含めてください

完了の定義

すでに読み込まれている references/audit_worker_core_contract.md を適用します。

• contextStore の解析に成功した（output_dir を含む）
• すべてのソースファイルをスキャンした（contextStore から技術スタックを取得）
• 6 つのカテゴリすべてを監査した
• 重大度、場所、工数、推奨事項を含む指摘を収集した
• ペナルティアルゴリズムを使用してスコアを算出した
• {output_dir}/ln-613--global.md にレポートを書き込んだ（Write を 1 回だけ呼び出すアトミックな書き込み）
• コントラクトに従ってサマリーを書き込んだ

参照ファイル

• コメントのルールとパターン：references/comments_rules.md

---

バージョン： 4.0.0 最終更新日： 2026-03-01