Code Wiki

Code Wiki是什么?

Code Wiki是谷歌推出的AI原生代码文档类工具，依托AI大模型能力打造智能化的代码知识库体系，从解决代码文档维护麻烦、更新滞后、理解成本高的问题，联动代码与文档，为程序员的开发工作助力，提供开发性文档及代码自动理解能力，是适应各种开发环境的开发文档工具。

Code Wiki主要功能

• 自动化代码文档生成：无需编写自定义注释和文档，可以直接使用代码仓库，从代码中解析代码结构、逻辑、调用关系等信息，自动智能生成格式规范、结构完整的代码文档。
• 文档实时同步更新：关联代码仓库的更新动作，当代码更改、迭代时，同步更新对应的文档，使文档与代码同步，不出现文档滞后现象。
• 自然语言代码问答：能够用自然语言向工具询问代码相关问题，快速找到相关代码并解答代码功能、代码调用、代码结构等问题答案，不需手握代码逐行尝试跟踪。
• 代码架构可视化：将代码结构复杂问题、代码联系、代码调用，还原为可视图表，直接了解项目的代码结构和逻辑关系，降低理解代码结构的难度。
• 代码检索与定位：实现精确代码检索功能，可按关键词、功能模块、代码片段等功能快速定位到代码所在位置，可关联到相同的文档说明，实现代码与文档之间的联动查看。
• 团队协作文档管理：支持团队的文档权限和协作文档操作，可实现代码文档的共享、批注、文档溯源功能，满足团队研发中的文档协作文档需求。

适用场景

• 新成员项目上手：帮助开发团队新成员快速查看规范化的代码文档、可视化的代码结构，快速了解项目代码逻辑、项目总体设计，大大缩短上手周期。
• 团队文档维护提效：可自动实现代码文档的生成和同步更新，替代开发人员的文档手动编写、维护的工作，减少团队文档维护的时间和人员成本。
• 系统结构直观梳理：架构师、开发人员可以获得代码架构的直观图示化能力，将系统结构、模块关联直观化，快速把握整个系统的结构、模块间逻辑关系。
• 大型项目复杂逻辑解析：对代码量较大、逻辑复杂的大型开发项目，可以实现更精准的代码查找、逻辑跟踪，帮助开发人员快速找到目标代码、理解复杂业务和代码逻辑，协助快速开发维护项目等。

Code Wiki怎么使用?

1. 访问官方平台：打开浏览器进入Code Wiki官网(https://codewiki.google/)，无需注册登录，可直接使用基础功能。
2. 输入仓库信息：在首页的搜索框中输入你想学习的代码仓库 URL（不限于 GitHub 仓库、GitLab 仓库、Bitbucket 仓库等），也可以输入仓库名（GitHub 名也可以）查找该仓库的仓库名；如果是私有仓库，要加相应的访问认证令牌。
3. 生成文档：确认仓库信息后点击生成按钮，系统将自动扫描代码仓库中的代码结构、调用关系等，生成结构化Wiki文档、可视化架构图及模块说明，等待片刻即可完成处理。
4. 浏览查看文档：进入生成文档的详情页面，可以快速跳转到左侧目录的各种链接，包括系统概览、系统模块说明、类和函数介绍等；页面中间可见完整文档内容，同时可以看到自动生成的代码调用关系图、代码组件关系图等。
5. 自然语言问答交互：通过页面右侧的 Gemini AI 对话框，用自然语言询问代码的相关问题，如“这个模块做的是什么事”、“项目入口的文件在哪儿”，AI 将给出基于代码库上下文的精确回答，并提供相关代码文件链接。
6. 项目快速熟悉：先看文档概览与项目模块划分，对项目有一个大体的印象；对于复杂的逻辑、过程等，通过图表、问答等模块迅速找到对应代码和对应逻辑。
7. 团队协作与验证：生成出来的文档可以作为团队新成员快速入门用，也可以直接当文档稿使用，人工修改完善后，成为团队自己的文档标准；还可以和文档一起，返回到代码库中校验文档里给出的信息，确认逻辑与实际代码一致。
8. 高级配置（可选）：根据自己的需求，设置高级参数比如文档生成所用的语言、选择自己的 AI 模型、取消掉不解析的代码目录；企业团队也可以通过 Gemini cli 扩展，部署在自己的服务器上，匹配私有仓库的使用需求。 

通过新媒派分享的以上简单的几个步骤，你就能快速掌握该工具的核心使用方法。