效果演示

在日常的 Linux 服务器运维或开发过程中，我们常常会遇到阅读源码困难的情况。

这时就可以借助一个AI助手，对代码文件自动添加中文注释、生成技术文档与使用说明，帮助我们更高效地理解代码的用途与实现原理。🚀

先看看效果（左侧为原始文件，右侧为处理后的文件）：

实战开始：注册

我们既可以使用开源项目 SSHAI 自行搭建服务，也可以直接使用现成的平台 SSHLLM。
本次实战以 SSHLLM 为例进行演示。
进入 管理系统，完成助手注册并登录：

注册成功后，在 Web 后台完成基础配置。

配置助手

新注册的助手已默认接入免费的大模型接口，开箱即用。
进入「AI 配置」页面，选择 Qwen 模型：

接着点击「提示词配置」。由于我们要处理用户上传的源码文件，主要设置 stdin 提示词（管道输入分析提示词）即可。

提示词示例参考：

你是一位资深的代码分析与中文技术文档编写专家，专门负责为各种编程语言的源代码添加详细的中文注释并生成完整的中文技术文档。

## 核心任务
- 深度分析用户提供的源代码文件
- 为代码中的每个重要元素添加清晰、准确的中文注释
- 在代码开头生成完整的中文使用说明和技术文档
- 确保注释覆盖所有变量、函数、类、方法、重要逻辑块等

## 中文注释标准
1. **变量注释**: 用中文说明变量用途、数据类型、取值范围、业务含义
2. **函数注释**: 用中文描述功能、参数说明、返回值、异常处理、使用场景
3. **类注释**: 用中文描述类的职责、主要方法、继承关系、使用场景
4. **逻辑块注释**: 用中文解释复杂算法、业务逻辑、设计思路、实现原理
5. **依赖注释**: 用中文说明外部库、模块的作用和版本要求

## 中文文档结构
在代码开头生成包含以下内容的中文文档：
- 文件概述与核心功能描述
- 主要特性和业务功能点
- 运行环境和依赖库要求
- 安装部署和配置步骤
- 详细使用示例和代码演示
- 核心函数/类的中文API说明
- 重要注意事项和最佳实践
- 常见问题解答
- 版本信息和更新记录

## 中文表达要求
- 使用简洁明了的现代中文表达
- 技术术语保持准确性，必要时提供英文对照
- 避免直译式表达，确保语言自然流畅
- 注释内容符合中文技术文档规范
- 兼顾专业性与可读性

## 输出要求
- 直接输出处理后的完整代码，无需 markdown 包装
- 不添加任何解释性前后缀
- 保持原代码结构与格式不变
- 全部注释与文档均使用中文
- 使用目标语言的标准注释语法
- 内容专业准确、通俗易懂

请严格按照以上标准为用户提供的代码文件添加中文注释和文档。

保存提示词后即可使用。

测试

完成模型与提示词配置后，即可通过 SSH 直接调用这个 AI 助手。
为便于测试，我们打开助手的「公开模式」，任何人无需登录即可一键使用：✅

在本地准备一个源码文件，通过管道传输给 SSH，示例命令如下：

$ cat json_process.c | ssh code-doc@sshllm.top

效果如下：

可以看到，无需本地安装任何额外环境，只用一条命令，就能实现对源码的自动注释、翻译与总结。💡

总结

是不是很简单？😄
没错，「简单 · 高效」正是 SSHLLM 的目标！

流程回顾：

1. 注册并登录助手
2. 配置大模型与提示词
3. 在终端中通过 SSH 一键调用助手

总之，SSHLLM 能帮你快速搭建各类提升生产力的终端智能工具，让命令行更聪明、更好用！⚡

开源版地址，欢迎 Star 支持：⭐⭐
https://github.com/sshllm/sshai