Dart ファイルの DartDoc コメントを体系的に管理し、高品質な日本語ドキュメントを維持します。
Manages DartDoc comments systematically and maintains high-quality Japanese documentation.
/plugin marketplace add wasabeef/claude-code-cookbook/plugin install cook@claude-code-cookbookDart ファイルの DartDoc コメントを体系的に管理し、高品質な日本語ドキュメントを維持します。
# 新規追加と更新を同時に実行
「DartDoc コメントがないクラスに追加し、基準を満たさないコメントを更新してください」
# PR の変更ファイルを確認
「PR #4308 で変更されたファイルの DartDoc に Claude マーカーがあるか確認してください」
# 特定ディレクトリのドキュメント整備
「packages/app/lib/ui/screen/ 配下の Widget クラスに DartDoc を追加してください」
# マーカーなしで実行
/update-dart-doc --marker false
「既存プロジェクトの DartDoc を改善 (Claude マーカーは付けない)」
--marker <true|false> : Claude マーカーを付与するか (デフォルト: true)# 1. 対象ファイルの分析
find . -name "*.dart" -not -path "*/.*" | grep -v "_test.dart" | grep -v "_vrt.dart"
「DartDoc が不足しているクラス (コメント行数 0 または 30 文字未満) を特定してください」
# 2. ドキュメント追加
「特定されたクラスに必須要素を含む DartDoc コメントを追加してください」
# 3. マーカー確認
「追加・更新したすべての DartDoc に Claude マーカーがあることを確認してください」
対象要素:
基本構造:
/// {要素の概要説明}(30-60 文字、必須)
///
/// {詳細説明}(役割、使用コンテキスト、注意点を必ず含む、50-200 文字)
///
/// Generated by Claude 🤖
@アノテーション // 既存アノテーションは変更しない
class クラス名 {
文章スタイル:
状態管理クラス (Riverpod):
/// 水平スワイプジェスチャーの無効化状態を管理する State です。
///
/// 特定の画面や操作中に水平スワイプを無効化する必要がある場合に
/// 使用します。例えば、カルーセル表示中や特定の入力中など。
///
/// Generated by Claude 🤖
@Riverpod(keepAlive: true, dependencies: [])
class HorizontalDragGestureIgnoreState extends _$HorizontalDragGestureIgnoreState {
Widget クラス:
/// ユーザープロフィールを表示する Widget です。
///
/// アバター画像、ユーザー名、ステータス情報を縦に配置し、
/// タップ時にプロフィール詳細画面へ遷移します。
///
/// Generated by Claude 🤖
class UserProfileWidget extends HookConsumerWidget {
保持すべき重要情報:
See also: で始まる参照TODO(user_name): 形式注意: や Warning: などの警告例: や Example: で始まるコード# マーカー形式
/// Generated by Claude 🤖
# PR の変更ファイルでマーカー確認
gh pr diff 4308 --name-only | grep "\.dart$" | xargs grep -l "Generated by Claude"
「マーカーがないファイルに追加してください」
🔴 絶対禁止事項:
*_test.dart) への文字数基準未満のコメント*_vrt.dart) への文字数基準未満のコメント静的解析とコミット:
# 実行結果の記録
ADDED_COMMENTS=0
UPDATED_COMMENTS=0
ERRORS=0
# 変更後の確認
melos analyze
if [ $? -ne 0 ]; then
echo "🔴 エラー: 静的解析が失敗しました"
exit 1
fi
# 実行サマリーの出力
echo "📊 実行結果:"
echo "- 追加したコメント: $ADDED_COMMENTS 件"
echo "- 更新したコメント: $UPDATED_COMMENTS 件"
echo "- エラー発生数: $ERRORS 件"
# コミット例
git commit -m "docs: DartDoc コメントを追加・更新
- 基準を満たさないクラス、enum、extension に DartDoc を追加
- 30 文字未満のコメントを基準に沿って更新
- Claude マーカーを統一的に付与
実行結果:
- 追加: $ADDED_COMMENTS 件
- 更新: $UPDATED_COMMENTS 件
Generated by Claude 🤖"
完了判定: 以下をすべて満たす場合に成功
melos analyze が PASSED部分成功: 以下の場合
失敗: 以下の場合
melos analyze が FAILED