代码注释(免费)。生成规范化的代码注释:适用于代码可读性提升、团队协作、交接维护场景,解决「代码没注释看不懂、注释写了等于没写、风格不统一」的问题。用户只需提供相关信息,AI 即按内置提示词模板输出完整结果。
生成规范化的代码注释:适用于代码可读性提升、团队协作、交接维护场景,解决「代码没注释看不懂、注释写了等于没写、风格不统一」的问题。最终目的:产出可直接套用的注释提示词:用户只需粘贴代码,AI 即输出符合规范的完整注释。本技能内置可直接套用的提示词模板,加载后 AI 按模板工作,无需额外配置。
当用户提出以下类型的需求时,激活本技能:
激活后,按下方【内置提示词模板】执行:将用户提供的信息填入模板占位处(____),直接输出完整结果;用户未提供的信息保持占位并提示其补充。
【角色设定】 你是代码文档工程师,擅长写「讲清为什么」的高质量注释。 【任务】 根据我的代码,帮我添加注释。 【我会提供的信息】 1. 代码(粘贴):____ 2. 编程语言:____ 3. 注释风格偏好(行注释/文档注释/团队规范):____ 4. 注释语言(中文/英文):____ 5. 特别需要解释的部分(可不填):____ 【注释要求】 1. 注释层级:文件头注释(功能/作者/日期)、函数注释(功能/参数/返回/异常)、关键行注释(复杂逻辑/为什么这么写)。 2. 讲「为什么」多于「是什么」:不说「i 加 1」,说「跳过已处理项」。 3. 不为显而易见的代码写废话注释。 4. 命名规范统一:与代码风格一致。 5. 输出带注释的完整代码 + 注释规范说明。 【输出格式】 一、完整注释代码 二、注释要点说明(写了哪些类型的注释) 三、规范建议(2 条,如命名/注释频率) 请直接输出,不要询问多余信息;代码缺失处用「____」占位。
____ 占位并提示用户补充。场景描述: 用户需要为不同编程语言的代码生成注释。例如,用户可能需要同时为 Python 和 Java 代码生成注释。
参数/步骤:
编程语言 参数填写为 Python, Java。组合技巧:
场景描述: 用户希望生成符合特定团队或项目规范的注释。例如,某个团队使用 Javadoc 风格注释。
参数/步骤:
注释风格偏好 参数填写为 文档注释。特别需要解释的部分 中注明哪些部分需要详细解释。组合技巧:
特别需要解释的部分 中详细说明,以确保注释的准确性和完整性。场景描述: 用户有多个代码文件需要一次性生成注释。例如,一个项目包含多个 Python 文件。
参数/步骤:
编程语言 参数填写为 Python。组合技巧:
场景描述: 用户希望在生成注释的同时进行代码审查和优化。例如,在生成注释时发现代码中有潜在的逻辑错误或性能问题。
参数/步骤:
特别需要解释的部分 参数填写为所有代码段。特别需要解释的部分 中注明哪些部分需要详细审查和优化。组合技巧:
场景描述: 用户需要为一个 Python 函数生成详细的注释。函数用于计算两个数的和,并处理异常情况。
输入示例:
def add_numbers(a, b):
try:
return a + b
except TypeError as e:
print(e)
输出要点:
场景描述: 用户需要为一个 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 函数生成详细的注释,并在注释中提出代码优化建议。函数用于计算数组的平均值。
输入示例:
function average(arr) {
let sum = 0;
for (let i = 0; i < arr.length; i++) {
sum += arr[i];
}
return sum / arr.length;
}
输出要点:
reduce 方法简化代码,提高可读性。优势描述: 本工具生成的注释符合规范,详细且清晰地解释了代码的功能和逻辑。这不仅提高了代码的可读性,还方便团队协作和交接维护。
优势描述: 用户无需手动编写注释,只需提供相关信息,AI 即可自动生成完整注释。这大大节省了时间,并减少了人工错误的可能性。
优势描述: 本工具内置多个注释模板,支持多种编程语言和风格。用户可以根据需要选择合适的模板,确保项目中的注释风格统一,便于管理和维护。