Dart API 文档编写

原名：dart-write-documentation

按照 Effective Dart 规则编写库、类、方法和字段的三斜线文档。

中文 Skills 技能说明

适合补充公开 API、复杂行为和使用示例。文档应解释调用者需要知道的约束、异常和边界，不重复代码字面意思，也不编造尚未实现的行为；完成后应检查链接、示例和 dart doc 输出。

上游能力依据

上游原始适用说明：Rules and formatting guidelines for writing Dart /// API documentation and doc comments. Use when documenting Dart code, writing doc comments for any Dart declaration (libraries, classes, methods, variables, etc.), or when instructed to follow the Effective Dart documentation guidelines.

上游 SKILL.md 主要章节（保留原文标题）：

Contents
1. Scope and Structure
2. Tone and Openers
3. Strict Anti-Patterns (Banned)
4. Technical Placement & Resolution
5. Linking and Markdown
6. Verification
Examples
1. Banned Tags vs. Prose
2. The Annotation Placement Trap

使用边界

先提供真实业务背景、目标受众和可核验资料。输出是工作草稿或决策辅助，不补造客户反馈、经营数据、案例或引用。

作者、翻译与许可证

原作者: The Flutter Authors 与 flutter/agent-plugins contributors
中文翻译: CEOFans翻译
许可证: BSD-3-Clause
上游来源: https://github.com/flutter/agent-plugins/tree/864cf8797b190ddb81e4875db6dd6bab89641f62/skills/dart-write-documentation

适用范围

平台：linux、macos、windows；标签：效率与知识、Dart API 文档编写

安全提示

基础静态扫描不等于绝对安全。技能可能调用命令、浏览器、云服务或本地文件，请在最小权限环境中使用，高风险操作必须人工确认。

如发现侵权、许可证或安全问题，可在本页前台提交投诉，管理员复核后可立即下架。