产品介绍
Komment 是什么？
Komment 是面向工程团队的自动软件文档平台。用户连接代码仓库，启动文档任务或设置计划，即可获得专属 wiki 门户，其中包含使用说明、API 参考、架构视图、实现细节、安全洞察、示例和代码内注释。系统监测代码变化，并在代码与文档出现偏差时重新生成文档。
Komment 将 AI 与静态分析、专用启发式方法和多层 QA 结合。团队可集中控制文档语气、深度、格式、新鲜度和覆盖范围。官网介绍了托管 SaaS 和私有云部署，并称注重隐私的组织可将代码处理限制在所选部署中。
如何使用 Komment
- 使用邮箱或受支持的 git 账户登录。
- 连接需要文档化的代码仓库。
- 选择文档类型、风格、深度和覆盖范围。
- 使用 Quickstart 创建首个 wiki，或配置周期计划。
- 将生成的架构、API、安全和实现内容与代码核对。
- 保持同步启用，并随代码改动审核文档变化。
核心功能
- 自修复 wiki： 当仓库变化造成偏差时重新生成软件文档。
- API 文档： 描述端点、请求、响应、状态码和错误。
- 架构图： 生成并更新代码库的系统级视图。
- 实现细节： 使用示例和片段解释业务逻辑。
- 安全洞察： 跟踪数据和模块关系，用于监控与规划。
- 代码内注释： 为相关代码实体添加上下文说明。
- 集中标准： 跨团队和仓库控制风格与覆盖。
- 私有部署： 支持部署到选定云基础设施。
使用场景
- 开发者接入： 为新工程师提供陌生代码的最新说明。
- 遗留系统现代化： 从缺少文档的系统恢复知识。
- API 维护： 让端点参考与实现保持一致。
- 架构审核： 随代码演进查看模块和依赖。
- CI/CD 文档： 在交付流程中重新生成并审核文档。
价格
Free 方案标价为每月 0 美元，支持不限量公共仓库且无需信用卡。新用户可试用 30 天付费功能，之后如不升级则转为 Free。本次审核首页没有展示付费套餐金额。
常见问题
Komment 可以生成哪些文档？
官网列出使用指南、架构图、概览、实现细节、API 文档、安全洞察、示例和代码内注释。
它会保持文档同步吗？
会。Komment 监测代码变化，并在发现偏差时重新生成文档。
可以在私有基础设施中运行吗？
官网介绍了通过主要云提供商进行私有云部署。
