SuperAPI AI 工具集

dart-write-documentation

写作与研究

查看项目

更新于 10-15 20:32

技能介绍

用途:为 Dart 代码编写或更新 /// API 文档注释时遵循的格式与规范指南,适用于公开声明的文档写作与审查。

主要能力与规则: 范围与结构:只记录公开声明,除非明确要求不注释以下划线开头的私有成员;统一使用 /// 连续行注释,禁止 /** ... */ 块注释;注释按完整句子书写,首词大写并以句号结尾;首段必须是概括该元素的单个简洁句子,并用 /// 空行与后文分隔,不要输出不带 /// 的真空行。 语气与开头:变量、getter、setter 用名词短语开头;布尔属性用 Whether 开头;方法与函数用第三人称动词开头;不要复述签名或元素名。 禁用项:不得使用 Javadoc/TSDoc 风格标签(@param、@return、@returns、@throws、@exception、@see、@type),参数、返回值与异常应写入散文。 技术放置:文档注释要放在 @override 等元数据注解之前;@override 成员行为与父类一致时避免重复文档;getter/setter 成对时只写在 getter 上;链接默认无名构造函数需用 [ClassName.new]。 链接与 Markdown:作用域内符号用方括号链接,参数不要用反引号;方法链接不加括号;关键字与字面量用反引号,不放入方括号;跨库符号用文件顶部 library; 上的 @docImport 指令而非普通 import;代码块必须标注语言围栏(如 dart、sh);首段之后可用标准 Markdown 说明边界情况、异常与内部行为。 校验:写完后运行 dart analyze 确认方括号引用可解析、不触发 comment_references 警告;可选运行 dart doc 检查渲染。

限制:文中未提供工具自身的安装方式、收费、价格或平台支持信息;具体适用版本与更多细节暂未提供。