SuperAPI AI 工具集

code-documentation

编程与开发

查看项目

更新于 10-15 21:43

技能介绍

用途:为代码编写有效文档,覆盖文档注释(docstring、JSDoc、dartdoc)与实现注释,适用于编写新代码或补充文档时参考。

主要能力:提供跨语言的文档写作规范。核心理念是以 API 使用者为中心,解释代码为何存在及如何有效使用,而非复述代码签名;要求简洁、术语与格式一致;所有公开 API(类、成员、顶层函数)都应记录,并鼓励添加代码示例。

结构要求:文档注释首行为单句摘要并以句号结尾,随后空一行,再补充细节、代码示例或列表,说明参数、返回值、异常与行为;文档注释置于元数据注解之前。

写作规范:避免“This class…”“This method…”“Is used to…”等冗余表述;函数与方法文档以第三人称单数动词开头(如 Returns、Calculates);变量与属性以名词短语开头;布尔值以 Whether 开头;避免行话,除非是通用标准术语。格式上少用 Markdown,避免 HTML;参数、返回值与异常优先用散文描述,除非语言标准强制使用 @param 等标签。

实现注释:确保 // 注释准确、相关、属实,且提供代码本身不易理解的信息;不符合者应删除或改写;若其中信息对 API 使用者有用且未出现在文档注释中,应移入文档注释。

审查清单:检查每个公开成员是否以单句摘要开头并以句号结尾;删除冗余表述;记录严格约束(如“must not be null”)与异常;为复杂组件或方法考虑添加代码示例。

语言特定指南:Dart/Flutter 见 references/dart.md,TypeScript/JavaScript 见 references/typescript.md,Python 见 references/python.md。

限制:资料未提供具体安装命令、收费方式或平台支持信息。