系統地管理 Dart 文件的 DartDoc 注釋,維護高質量的中文文檔。
Manages DartDoc comments for Dart files, maintaining high-quality Chinese documentation.
/plugin marketplace add wasabeef/claude-code-cookbook/plugin install cook-zh-tw@claude-code-cookbook系統地管理 Dart 文件的 DartDoc 注釋,維護高質量的中文文檔。
# 同時執行新增和更新
「為没有 DartDoc 注釋的類添加注釋,並更新不符合標準的注釋」
# 確認 PR 的更改文件
「確認 PR #4308 中更改的文件是否有 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/update-dart-docGerencia sistematicamente comentários DartDoc de arquivos Dart e mantém documentação em português de alta qualidade.
/update-dart-docSystematically manages DartDoc comments in Dart files and maintains high-quality Japanese documentation.