Systematically manages DartDoc comments in Dart files and maintains high-quality Japanese documentation.
Adds or updates DartDoc comments for classes, enums, and extensions in Japanese, following strict quality standards with Claude markers. Use it to systematically improve documentation in Dart projects, especially for PR reviews or maintaining consistency across large codebases.
/plugin marketplace add wasabeef/claude-code-cookbook/plugin install cook-en@claude-code-cookbookSystematically manages DartDoc comments in Dart files and maintains high-quality Japanese documentation.
# Perform new additions and updates simultaneously
"Add DartDoc comments to classes without them and update comments that don't meet standards"
# Check changed files in PR
"Check if there are Claude markers in the DartDoc of files changed in PR #4308"
# Maintain documentation for specific directories
"Add DartDoc to Widget classes under packages/app/lib/ui/screen/"
# Execute without markers
/update-dart-doc --marker false
"Improve DartDoc in existing project (without Claude markers)"
--marker <true|false> : Whether to add Claude markers (default: true)# 1. Analyze target files
find . -name "*.dart" -not -path "*/.*" | grep -v "_test.dart" | grep -v "_vrt.dart"
"Identify classes with insufficient DartDoc (0 lines or less than 30 characters)"
# 2. Add documentation
"Add DartDoc comments containing required elements to the identified classes"
# 3. Check markers
"Ensure all added/updated DartDoc have Claude markers"
Target elements:
Basic structure:
/// {Element summary} (30-60 characters, required)
///
/// {Detailed description} (must include role, usage context, and notes, 50-200 characters)
///
/// Generated by Claude 🤖
@annotation // Do not change existing annotations
class ClassName {
Text style:
State management class (Riverpod):
/// State that manages the disabled state of horizontal swipe gestures.
///
/// Used when horizontal swipes need to be disabled during specific screens or operations,
/// such as during carousel displays or specific inputs.
///
/// Generated by Claude 🤖
@Riverpod(keepAlive: true, dependencies: [])
class HorizontalDragGestureIgnoreState extends _$HorizontalDragGestureIgnoreState {
Widget class:
/// Widget that displays a user profile.
///
/// Vertically arranges avatar image, username, and status information,
/// and navigates to the profile detail screen when tapped.
///
/// Generated by Claude 🤖
class UserProfileWidget extends HookConsumerWidget {
Important information to preserve:
See also:TODO(user_name):Note: or Warning:Example: or Usage:# Marker format
/// Generated by Claude 🤖
# Check markers in PR changed files
gh pr diff 4308 --name-only | grep "\.dart$" | xargs grep -l "Generated by Claude"
"Add markers to files that don't have them"
🔴 Absolute prohibitions:
*_test.dart)*_vrt.dart)Static analysis and commit:
# Record execution results
ADDED_COMMENTS=0
UPDATED_COMMENTS=0
ERRORS=0
# Check after changes
melos analyze
if [ $? -ne 0 ]; then
echo "🔴 Error: Static analysis failed"
exit 1
fi
# Output execution summary
echo "📊 Execution results:"
echo "- Added comments: $ADDED_COMMENTS"
echo "- Updated comments: $UPDATED_COMMENTS"
echo "- Errors: $ERRORS"
# Example commit
git commit -m "docs: Add and update DartDoc comments
- Add DartDoc to classes, enums, and extensions that don't meet standards
- Update comments under 30 characters to meet standards
- Uniformly add Claude markers
Execution results:
- Added: $ADDED_COMMENTS
- Updated: $UPDATED_COMMENTS
Generated by Claude 🤖"
Complete success: When all of the following are met
melos analyze PASSEDPartial success: When
Failure: When
melos analyze FAILED