第 11 篇:搜索与文档能力

第 11 篇：搜索与文档能力

写代码之外，开发者日常还有两件躲不掉的事：查文档和写文档。Claude Code 在这两个场景里表现不错，尤其是联网搜索和文档生成——这篇聊聊怎么用。

一、联网搜索

大部分 AI 编程助手的知识截止于训练数据的日期。Claude Code 可以联网搜索，获取最新的信息。这对于日常开发中的几个场景特别有用：

场景一，最新 API 的用法。 你用的库昨天刚发布了新版本，API 变了。Claude Code 可以直接搜索官方文档，返回最新的用法，而不是它训练数据中那个过期版本。

/seek React 19 的 use Hook 怎么用，给一个实际例子

场景二，错误信息的解决方案。 遇到一个冷门的编译错误，Stack Overflow 上可能有答案。Claude Code 可以搜索并提取相关解决方案。

遇到这个错误：Module not found: Error: Can't resolve 'fs' in './src/browser' 搜索一下这个错误的常见原因和解决方法

场景三，技术选型对比。 不确定用哪个库好时，可以让 Claude Code 搜索对比。

搜索一下 Zod 和 Yup 在 2025 年的社区活跃度、包体积和性能差异我需要一个类型安全的表单验证库

联网搜索用 /seek 命令触发，Claude Code 会在搜索结果中提取关键信息，并在回答中标注来源。你可以直接点击来源链接进一步查看。

二、从代码生成文档

写文档是件程序员普遍不爱做但必须做的事。Claude Code 在这方面做得不错，因为它已经读懂了你的代码——不需要你额外解释。

生成 README：

在项目根目录启动 Claude Code，说：

给我生成一份 README.md，包含项目简介、安装方式、使用示例、API 说明和许可证信息

生成的 README 不会只是套模板。因为 Claude Code 读了你的代码，它知道项目具体做什么、怎么安装、不同 API 的参数和返回值是什么。你只需要做最后的润色和补充。

生成 API 文档：

给我生成一份 API 文档，包含项目中所有公开函数的签名、参数说明、返回值类型和使用示例

生成的文档格式可以直接用，也可以导出为 Markdown 文件。

生成变更日志：

查看最近的 Git 日志，生成一份 CHANGELOG.md

这个结合 Git 历史的能力很实用。每次发版前跑一次，变更日志就自动整理好了。

三、代码注释和文档字符串

相比生成独立文档，Claude Code 更擅长的是给代码本身加注释。它已经理解每段代码做了什么，所以生成的注释不会说废话。

给 src/utils/ 下的所有函数加上 JSDoc 注释，包括参数类型、返回值说明和简单的使用示例

生成的结果会考虑项目已有的注释风格。如果项目中用的是 @param {string} name 的格式，Claude Code 会保持一致。

你也可以让 Claude Code 在你写代码的过程中实时加注释，不用一次性处理全部文件。

四、搜索已写过的代码

Claude Code 对项目的理解让它能回答关于代码的问题，而不只是查找文件。

项目中有没有处理过类似的 CSV 导入逻辑？我想知道之前是怎么做的

Claude Code 会在你项目已有的代码中找到相关实现，告诉你逻辑在哪个文件、做了什么处理、能不能复用。这比你自己 grep 或者翻目录快得多——尤其在一个你很久没动过的项目里。

这个错误处理模式在项目中其他地方出现过吗？当时的处理方式是什么？

这类问题写代码时经常会问。Claude Code 能告诉你之前的项目中是怎么处理类似情况的——前提是它一直记得。

五、写技术说明文档

除了 API 文档和 README，Claude Code 还可以生成一些更偏技术的文档类型：

架构决策记录（ADR）：

帮我写一份 ADR，记录为什么选择 PostgreSQL 而不是 MongoDB，包括背景、考虑过的方案、决策理由

部署文档：

根据项目的 Docker 配置和 package.json 中的脚本，生成一份部署说明

内部知识库文档：

把项目中的配置规则和编码约定整理成一份开发指南

这些文档类型有固定的结构，Claude Code 很擅长套用模板填入具体内容。你只需要补充一些它不知道的信息——比如业务背景、团队偏好——文档就完整了。

六、注意事项

用 Claude Code 做搜索和文档有几个地方需要注意：

联网搜索依赖网络质量，代理或防火墙可能影响 /seek 功能

生成的文档需要人工校对。Claude Code 理解代码结构，但可能不理解产品的目标用户和使用场景

自动生成的 API 文档能覆盖 90% 的内容，但需要你手动补充"为什么这么做"的部分

文档的持续维护还是得靠人——每次改完代码后跑一次 Claude Code 是值得养成的习惯

文档生成不是一次性的工作，而是和代码修改同步的持续流程。Claude Code 能帮你把这个流程的成本降到最低。

试试看： 找一个你主导的项目，用 Claude Code 生成一份 CHANGELOG.md，看看它从 Git 历史中提取的变更信息是否完整。