用途:agentic-docs 用于编写和评审需要内联文档的代码,倡导把文档写在代码旁边,因为分离的文档文件容易与代码脱节,而注释与代码一起更新更易保持一致。
主要能力:给出多个文档层级与写法。文件头说明模块职责、存在原因、与其他部分的关系及非显而易见的设计决策;函数与方法文档写契约而非实现,包含用途、参数约束、返回值含义和副作用,并说明简单 getter 可省略;内联注释少量使用并说明理由;架构注释解释设计取舍;TODO 类注释要求可操作、可追踪并注明移除条件。还强调面向三类读者写作,写前用“为什么”检验,只有复述代码动作就省略。
使用方式:在编写或评审代码时按上述层级添加注释;语言示例另见 references/language-examples.md,覆盖 TypeScript/JavaScript、Swift、Python 和 React/Next.js 等模式。
限 制:资料未提供安装方式、许可、定价或平台支持等信息,暂未提供。