CodeAsk 使用指南：基于大语言模型的代码阅读工具

1. 探索核心功能：CodeAsk 能为你做什么

目标：快速了解 CodeAsk 的核心价值与适用场景
核心步骤：
1️⃣ 认识代码解析能力
2️⃣ 了解安全漏洞检测功能
3️⃣ 掌握自定义分析规则

CodeAsk 是一款基于大语言模型（LLM）的智能代码分析工具，旨在解决开发者面对复杂代码库时的理解困难。通过自动化代码解析、安全漏洞检测和质量评估，帮助团队提升开发效率并降低维护成本。

💡 为什么选择 CodeAsk？
传统代码阅读工具需要手动梳理依赖关系，而 CodeAsk 借助 LLM 技术能自动生成代码结构分析报告，如组件关系、函数调用链等。例如，当导入一个包含 100+ 文件的项目时，CodeAsk 可在几分钟内生成可视化依赖图谱，而人工梳理可能需要数小时。

⚠️ 常见误区：

• 认为 CodeAsk 仅适用于大型项目 → 小型项目同样能通过它快速理解遗留代码
• 期待完全替代人工代码审查 → 工具结果需结合人工判断

检验标准：访问 src/pages/GlobalAnalysisPage.tsx 查看核心分析逻辑，确认包含代码结构解析和模型调用模块。

2. 搭建开发环境：从克隆到启动

目标：15 分钟内完成本地开发环境配置
核心步骤：
1️⃣ 克隆代码仓库
2️⃣ 安装依赖包
3️⃣ 启动开发服务器

# 克隆项目代码
git clone https://gitcode.com/gh_mirrors/co/CodeAsk
cd CodeAsk

# 安装依赖（推荐 Node.js 16+）
npm install

# 启动开发模式
npm run dev

💡 提速技巧：使用 npm install --registry=https://registry.npmmirror.com 加速国内依赖下载

⚠️ 注意事项：

• 确保系统已安装 Node.js 和 npm（可通过 node -v 验证）
• Windows 用户需使用 WSL 或 PowerShell 执行命令

检验标准：命令行显示 dev server running at http://localhost:3000，浏览器访问后能看到 CodeAsk 主界面。

3. 快速上手：3 步完成首次代码分析

目标：掌握基本分析流程，生成第一份代码报告
核心步骤：
1️⃣ 导入目标项目
2️⃣ 配置分析规则
3️⃣ 查看分析结果

图 1：CodeAsk 代码分析配置界面，可设置分析名称、模型和提示词

1️⃣ 导入项目：点击左侧「文件」→「打开文件夹」，选择本地代码目录
2️⃣ 配置分析：在顶部菜单选择「全局分析」→ 填写分析名称（如 "用户认证模块分析"）→ 选择「代码结构分析」模板
3️⃣ 执行与查看：点击「开始分析」，等待 20-30 秒后在右侧面板查看生成的分析报告

💡 效率提示：常用分析模板可保存至 src/data/prompt-templates.json，避免重复配置

检验标准：报告中应包含「组件关系图」「核心函数列表」和「潜在问题提示」三个部分。

4. 解析核心模块：理解工具内部工作原理

目标：掌握 CodeAsk 主要模块的协作方式
核心步骤：
1️⃣ 了解文件系统模块
2️⃣ 分析 LLM 交互逻辑
3️⃣ 理解结果渲染流程

CodeAsk 采用三层架构设计：

• 数据层（src/helpers/file_helpers.ts）：负责文件读取和路径处理
• 分析层（src/store/useGlobalAnalysisStore.ts）：管理 LLM 调用和分析任务队列
• 表现层（src/components/codeview/）：渲染代码和分析结果

图 2：CodeAsk 对 Python 文件的解析结果，包含函数说明和流程图

💡 技术类比：分析流程类似餐厅点餐——用户（前端）选择分析模板（菜单），LLM 服务（厨师）根据模板生成报告（菜品），最后通过 UI 组件（服务员）呈现给用户。

检验标准：修改 src/helpers/language_helpers.ts 中的语言识别规则，重新分析后能正确识别自定义文件类型。

5. 定制分析规则：打造个性化代码审查工具

目标：通过提示词模板和配置文件优化分析结果
核心步骤：
1️⃣ 创建自定义提示词模板
2️⃣ 配置模型参数
3️⃣ 测试并调整规则

图 3：多语言提示词模板选择界面，支持代码解释、审查等场景

1️⃣ 添加模板：编辑 src/data/prompt-templates.json，新增如下配置：

{
  "id": "security-scan",
  "name": "安全漏洞扫描",
  "prompt": "作为安全专家，请检测以下代码中的 SQL 注入和 XSS 漏洞：\n{{code}}"
}

2️⃣ 配置模型：在 src/store/useModelStore.ts 中设置默认模型参数：

const defaultModelConfig = {
  temperature: 0.3, // 推荐值：0.2-0.5（越低结果越稳定）
  maxTokens: 2048,  // 推荐值：1024-4096（根据分析复杂度调整）
};

3️⃣ 应用测试：使用新模板分析包含 eval() 函数的代码，验证是否能检测出安全风险。

⚠️ 配置陷阱：

• 温度值（temperature）过高会导致结果不稳定
• 最大 tokens 设得太小可能导致分析不完整

检验标准：新模板出现在分析配置界面，使用后能生成包含安全建议的报告。

总结

CodeAsk 通过 LLM 技术简化了代码理解流程，核心价值在于自动化分析和可定制规则。从环境搭建到自定义分析，掌握这些步骤后，你可以将其应用于日常开发、代码审查和安全检测等场景。如需深入功能开发，建议阅读 src/main.ts 了解应用入口逻辑。