用途:为 Dart 代码编写或更新 API 文档注释时,严格按 Effective Dart: Documentation 的格式规则执行,目标是产出可被 dartdoc 正确解析和渲染的 /// 注释。
主要能力与规则:只关注公有声明,不记录下划线开头的私有成员(除非明确要求);一律用连续 /// 行注释,禁用 /* */ 块注释。首段须为一句简洁概括并以句号结尾,随后用含 /// 的空行与后文分隔,不能输出完全空行。语气上,变量/getter/setter 用名词短语开头,布尔属性用 Whether 开头,方法/函数用第三人称动词开头,避免复述签名或元素名。禁止 Javadoc/TSDoc 风格标签(@param、@return、@throws 等),改为在行文中说明参数、返回值与异常。文档注释须放在 @override 等注解之前;@override 成员行为与父类一致时不重复文档;getter/setter 成对时只写在 getter 上。链接用方括号引用作用域内符号,方法链接不加括号,关键字与字面量用反引号,跨库链接用 @docImport。代码块须标注语言(如 dart、sh)。
使用方式:按上述规则编写或更新注释后,运行 dart analyze 确认方括号引用可解析且不触发 comment_references 警告;可选运行 dart doc 检查渲染效果。默认无名构造函数链接需用 [ClassName.new] 语法。
适用场景:Dart 库的公有 API 文档撰写、代码评审中的文档规范检查、生成 dartdoc 站点前的注释整理。
限制:资料未提供该技能的具体安装方式、支持平台、版本要求、收费价格或其他扩展功能,相关内容暂未提供。