代码注释（免费）
技能概述
生成规范化的代码注释：适用于代码可读性提升、团队协作、交接维护场景，解决「代码没注释看不懂、注释写了等于没写、风格不统一」的问题。最终目的：产出可直接套用的注释提示词：用户只需粘贴代码，AI 即输出符合规范的完整注释。本技能内置可直接套用的提示词模板，加载后 AI 按模板工作，无需额外配置。
适用场景
- 生成规范化的代码注释：适用于代码可读性提升、团队协作、交接维护场景，解决「代码没注释看不懂、注释写了等于没写、风格不统一」的问题
- 典型目的：产出可直接套用的注释提示词：用户只需粘贴代码，AI 即输出符合规范的完整注释
调用方式
当用户提出以下类型的需求时，激活本技能：
- "请帮我代码注释"
- "用代码注释的方法处理这个内容"
- "按代码注释模板生成"
激活后，按下方【内置提示词模板】执行：将用户提供的信息填入模板占位处（____），直接输出完整结果；用户未提供的信息保持占位并提示其补充。
内置提示词模板
【角色设定】
你是代码文档工程师，擅长写「讲清为什么」的高质量注释。
【任务】
根据我的代码，帮我添加注释。
【我会提供的信息】
1. 代码（粘贴）：____
2. 编程语言：____
3. 注释风格偏好（行注释/文档注释/团队规范）：____
4. 注释语言（中文/英文）：____
5. 特别需要解释的部分（可不填）：____
【注释要求】
1. 注释层级：文件头注释（功能/作者/日期）、函数注释（功能/参数/返回/异常）、关键行注释（复杂逻辑/为什么这么写）。
2. 讲「为什么」多于「是什么」：不说「i 加 1」，说「跳过已处理项」。
3. 不为显而易见的代码写废话注释。
4. 命名规范统一：与代码风格一致。
5. 输出带注释的完整代码 + 注释规范说明。
【输出格式】
一、完整注释代码
二、注释要点说明（写了哪些类型的注释）
三、规范建议（2 条，如命名/注释频率）
请直接输出，不要询问多余信息；代码缺失处用「____」占位。
输出要求
- 严格按模板指定的输出格式分节输出，不省略、不额外发挥。
- 内容真实合规：不编造数据，不确定处标注「需核实」；涉及专业领域以专业来源为准。
- 输出可直接复制使用，缺失信息用
____占位并提示用户补充。
注意事项
- 本技能为免费技能，无支付环节。
- 如需该场景的高阶版提示词与更多玩法，可在本技能基础上要求 AI 深化；高阶版含五步工作流与合规自检。
风险提示
- 本工具输出结果仅供参考，不构成专业意见或收益承诺；重要决策请自行核实并判断。
- 免费工具不提供持续服务保证，具体以 SKILLHub 平台规则为准。
🚀 高阶用法与进阶技巧
1. 多语言注释生成
场景描述：
用户需要为不同编程语言的代码生成注释。例如，用户可能需要同时为 Python 和 Java 代码生成注释。
参数/步骤：
1. 在提示词模板中，将 编程语言 参数填写为 Python, Java。
2. 提供两段代码，一段是 Python 代码，另一段是 Java 代码。
3. 确保其他参数（如注释风格偏好、注释语言等）根据需要进行填写。
组合技巧：
- 使用多语言支持的提示词模板，AI 将分别对每种编程语言的代码生成相应的注释。
- 如果代码量较大，可以分段输入，逐段处理后再合并结果。
2. 自定义注释风格
场景描述：
用户希望生成符合特定团队或项目规范的注释。例如，某个团队使用 Javadoc 风格注释。
参数/步骤：
1. 在提示词模板中，将 注释风格偏好 参数填写为 文档注释。
2. 提供代码，并在 特别需要解释的部分 中注明哪些部分需要详细解释。
3. 确保其他参数（如编程语言、注释语言等）根据需要进行填写。
组合技巧：
- 使用自定义的注释模板，AI 将按照指定风格生成注释。
- 对于复杂的逻辑或关键行，可以在 特别需要解释的部分 中详细说明，以确保注释的准确性和完整性。
3. 多文件注释批量处理
场景描述：
用户有多个代码文件需要一次性生成注释。例如，一个项目包含多个 Python 文件。
参数/步骤：
1. 在提示词模板中，将 编程语言 参数填写为 Python。
2. 提供所有需要注释的代码文件内容。
3. 确保其他参数（如注释风格偏好、注释语言等）根据需要进行填写。
组合技巧：
- 使用批量处理功能，AI 将一次性生成所有文件的注释，并按文件顺序输出结果。
- 对于每个文件，可以使用相同的模板和参数，确保注释风格的一致性。
4. 结合代码审查与优化
场景描述：
用户希望在生成注释的同时进行代码审查和优化。例如，在生成注释时发现代码中有潜在的逻辑错误或性能问题。
参数/步骤：
1. 在提示词模板中，将 特别需要解释的部分 参数填写为所有代码段。
2. 提供代码，并在 特别需要解释的部分 中注明哪些部分需要详细审查和优化。
3. 确保其他参数（如编程语言、注释风格偏好等）根据需要进行填写。
组合技巧：
- 结合代码审查功能，AI 将在生成注释的同时检查代码的逻辑和性能问题，并提出优化建议。
- 对于发现的问题，AI 会在注释中注明并提供解决方案，帮助用户提高代码质量。
📋 实战案例（3个真实场景）
案例一：Python 函数注释
场景描述：
用户需要为一个 Python 函数生成详细的注释。函数用于计算两个数的和，并处理异常情况。
输入示例：
def add_numbers(a, b):
try:
return a + b
except TypeError as e:
print(e)
输出要点：
- 文件头注释：功能描述、作者、日期。
- 函数注释：功能描述、参数说明（a: 第一个数，b: 第二个数）、返回值说明（两个数的和）。
- 异常处理注释：捕获并打印类型错误。
- 关键行注释：解释异常处理逻辑。
案例二：Java 类注释
场景描述：
用户需要为一个 Java 类生成详细的注释。类用于管理用户信息，并提供增删改查功能。
输入示例：
public class UserManager {
private List<User> users;
public void addUser(User user) {
users.add(user);
}
public void removeUser(User user) {
users.remove(user);
}
public User getUserById(int id) {
for (User user : users) {
if (user.getId() == id) {
return user;
}
}
return null;
}
}
输出要点：
- 文件头注释：功能描述、作者、日期。
- 类注释：类的用途（管理用户信息）。
- 方法注释：方法功能、参数说明、返回值说明。
- 关键行注释：解释循环逻辑和条件判断。
案例三：JavaScript 代码优化与注释
场景描述：
用户需要为一个 JavaScript 函数生成详细的注释，并在注释中提出代码优化建议。函数用于计算数组的平均值。
输入示例：
function average(arr) {
let sum = 0;
for (let i = 0; i < arr.length; i++) {
sum += arr[i];
}
return sum / arr.length;
}
输出要点：
- 文件头注释：功能描述、作者、日期。
- 函数注释：功能描述、参数说明（arr: 数组）、返回值说明（数组的平均值）。
- 关键行注释：解释循环逻辑和计算过程。
- 优化建议：使用 reduce 方法简化代码，提高可读性。
💰 价值对比（为什么这个工具值得用）
1. 提高代码可读性和维护性
优势描述：
本工具生成的注释符合规范，详细且清晰地解释了代码的功能和逻辑。这不仅提高了代码的可读性，还方便团队协作和交接维护。
2. 节省时间和精力
优势描述：
用户无需手动编写注释，只需提供相关信息，AI 即可自动生成完整注释。这大大节省了时间，并减少了人工错误的可能性。
3. 统一注释风格
优势描述：
本工具内置多个注释模板，支持多种编程语言和风格。用户可以根据需要选择合适的模板，确保项目中的注释风格统一，便于管理和维护。
🎯 使用场景与适用人群
适用人群
- 软件开发者
- 团队负责人
- 项目经理
- 代码审查人员
- 技术文档撰写者
使用场景
-
项目开发阶段
- 提高代码可读性，便于团队协作。
- 确保代码风格统一，方便交接维护。 -
代码审查与优化
- 自动生成注释并提出优化建议，提高代码质量。
- 捕获潜在的逻辑错误和性能问题。 -
新项目启动
- 生成规范化的代码注释模板，快速启动项目开发。
- 减少手动编写注释的时间和精力。 -
团队协作与交接
- 确保代码易于理解和维护，便于团队成员之间的交流和协作。
- 提供详细的注释说明，方便新成员快速上手。 -
技术文档撰写
- 生成高质量的代码注释，作为技术文档的一部分。
- 方便用户理解代码功能和逻辑，提高文档的可读性和实用性。
更多同类技能（按次付费）
这个技能只覆盖单一场景。同类场景已经整理成完整合集，
一次调用就能拿到整套提示词，省去每次重新拼提示词的时间。
推荐：编程开发合集（20 个提示词） — 代码审查 / 重构建议 / 测试用例 / 技术文档 / 架构设计等 20 个场景
在 SkillHub 搜索对应的合集技能即可查看，单次调用 ¥9.90，按使用次数计费。
更多同类技能（按次付费）
这个技能只覆盖单一场景。同类场景已经整理成完整合集，
一次调用就能拿到整套提示词，省去每次重新拼提示词的时间。
推荐：编程开发合集（20 个提示词） — 代码审查 / 重构建议 / 测试用例 / 技术文档 / 架构设计等 20 个场景
在 SkillHub 搜索对应的合集技能即可查看，单次调用 ¥9.90，按使用次数计费。
<!-- upsell:end -->
