用途:提供语言无关的文档编写与维护规范,规定何时写注释、注释应表达什么,以及项目应有哪些文档、何时创建与更新。
主要能力:注释遵循“写为什么,不写做什么”,覆盖推理与取舍、非显而易见的决策、变通方案、坑与约束;复杂算法可写高层“做什么”,公共 API 契约可写输入、输出与错误。能靠命名与结构表达的就不加注释,禁止注释显而易见的代码、保留被注释掉的代码和过时错误注释。README 必备 What、Why、Quick Start、Setup,快速上手紧跟在描述之后;还涵盖 ADR(背景、决策、后果)、ARCHITECTURE.md、CONTRIBUTING.md、CHANGELOG.md 与 API 文档的用途和创建时机;破坏性变更、新功能、弃用功能必须更新文档。维护上强调过期文档比没有文档更糟,无法维护时应删除、标注过时或指向代码。质量工具示例:lychee(brew install lychee)做离线链接检查,vale(brew install vale)做风格检查,并用 git 检测 90 天未更新文档。图表仅在澄清架构、数据流、状态机时使用,保持简单、文本化、可维护。
使用方式:作为编写团队规范或检查清单使用,可在 CI 中运行上述工具。文档错误码时须追踪真实代码路径,用 grep 核对常量实际使用,再写入文档。
限制:资料未提供具体平台限制、收费信息或强制采用的集成方式;规范为通用原则,需结合项目自行落地。