SuperAPI AI 工具集

code-documentation-standards

写作与研究

查看项目

更新于 10-16 08:46

技能介绍

用途:为多语言代码库(Python、HTML、CSS、JavaScript)提供统一的文档编写标准,确保创建或修改代码时同步维护文档,并在提交前修复 Markdown 校验错误。

主要能力与要求:覆盖函数、类、模板、CSS 类与 JavaScript 函数的文档注释规范;给出 Python 函数与类、类属性、数据库模型、API 路由的文档模板与示例;给出 HTML 模板注释、CSS 类注释、JSDoc 风格 JavaScript 注释示例;附带最佳实践(命名与格式一致、面向不了解代码库的开发者、记录边界情况与异常、说明实现动机)、维护要求(代码评审时审查文档、与代码同一次提交更新、标记废弃函数、删除已删除代码的文档)与质量检查清单。

使用方式:编写代码时按模板补充参数、返回值、异常与示例;提交前对仓库内 .md 文件运行 Markdown 校验,例如 markdownlint **/*.md,修复未闭合代码块、缺失链接目标、标题层级错误、表格格式、列表缩进等问题,并确认代码块语言标签、内部链接与示例有效性。

适用场景:需要跨 Python、前端与模板代码维持一致文档风格的项目,尤其是包含多语言内容与文化语境说明的项目(资料示例涉及 Chuukese 词典条目、翻译接口等)。

限制:资料未提供具体安装、配置、收费与平台信息;未说明该规范作为独立工具的运行方式,实际使用时需结合项目自有文档工具链与团队约定。