{{functionName}}

{{functionName}}

描述

{{description}}

参数

参数名	类型	必须	描述
{{#each params}}
{{name}}	{{type}}	{{required}}	{{description}}
{{/each}}

示例

{{exampleCode}}

4. **运行文档生成**
```bash
# 执行文档生成
npx claude-flow docgen

# 查看生成结果
open ./docs/index.md

5. 集成到开发流程 将文档生成命令添加到 package.json：

   "scripts": {
     "docs:generate": "npx claude-flow docgen",
     "precommit": "npm run docs:generate && git add docs/"
   }
   

验证方法

文档生成后，可以通过以下方式验证效果：

1. 检查输出目录中的文档文件是否完整
2. 修改一处代码注释，重新生成文档，确认变更已同步
3. 运行文档质量检查工具：npx claude-flow doccheck

📌 重要注意事项：文档自动化不是"设置后就忘"的解决方案。建议每月审查一次文档质量，每季度更新一次模板，以适应项目发展需求。

---

常见问题解答

在实施文档自动化的过程中，我们收集了一些开发团队最常遇到的问题：

Q: 文档自动化会完全取代人工编写文档吗？
A: 不会。文档自动化主要解决重复性、机械性的文档维护工作，而架构设计、使用指南等高度创造性的内容仍需要人工编写。理想模式是"AI生成+人工优化"的协作方式。

Q: 现有的代码注释质量不高，会影响文档自动化效果吗？
A: 会。文档自动化高度依赖代码注释质量。建议先花1-2周时间改进核心代码的注释规范，再实施自动化。系统也提供了注释质量检查工具：npx claude-flow commentcheck。

Q: 如何处理敏感信息，避免泄露到文档中？
A: 系统提供敏感信息过滤功能，可在配置文件中设置需要过滤的关键词或模式：

"sensitivePatterns": [
  "API_KEY", "SECRET", "password", "token"
]