Dart Doc Validation
# Dart Doc Validation
## 1. When to use this skill
Use this skill when:
- Writing or updating documentation comments (`///`) in Dart code.
- Checking for broken documentation links, references, or macros.
- Preparing a package for publishing to pub.dev.
## 2. Best Practices
### Validating Documentation Locally
Use the `dart doc` command with a temporary output directory to validate
documentation comments without polluting the local project workspace.
This command parses all documentation comments and reports warnings such as:
- `warning: unresolved doc reference`
- `warning: undefined macro`
**Command to run:**when to use it
Community prompt sourced from the open-source GitHub repo Agent-mag/skills (MIT). A "Dart Doc Validation" style prompt — adapt the placeholders and specifics to your task. Imported as-is and not independently retested here, so check the output before relying on it.
tags
lifestylecommunitygeneral
source
Agent-mag/skills · MIT