示例Skill - 代码注释生成器

功能描述

这个Skill用于为代码文件自动生成规范的注释。

使用场景

• 为新编写的函数添加文档注释
• 为现有代码补充注释
• 统一项目注释风格

使用方法

当用户请求为代码添加注释时，按照以下步骤执行：

步骤1: 识别代码语言

根据文件扩展名或代码语法识别编程语言：

• .js, .ts → JavaScript/TypeScript
• .py → Python
• .java → Java
• .go → Go

步骤2: 确定注释风格

不同语言使用不同的注释格式：

JavaScript/TypeScript:

/**
 * 函数描述
 * @param {类型} 参数名 - 参数说明
 * @returns {类型} 返回值说明
 */

Python:

"""
函数描述

Args:
    参数名: 参数说明
    
Returns:
    返回值说明
"""

Java:

/**
 * 方法描述
 * @param 参数名 参数说明
 * @return 返回值说明
 */

步骤3: 生成注释

1. 分析函数签名和参数
2. 理解函数功能
3. 生成简洁明了的注释
4. 保持注释与代码同步

示例

输入

function calculateTotal(price, quantity, tax) {
    return (price * quantity) * (1 + tax);
}

输出

/**
 * 计算商品总价（含税）
 * @param {number} price - 商品单价
 * @param {number} quantity - 购买数量
 * @param {number} tax - 税率（小数形式，如0.1表示10%）
 * @returns {number} 含税总价
 */
function calculateTotal(price, quantity, tax) {
    return (price * quantity) * (1 + tax);
}

注意事项

• 注释应简洁明了，避免冗余
• 对于复杂逻辑，添加必要的实现说明
• 保持注释与代码的一致性
• 遵循项目现有的注释规范

相关资源

• JSDoc官方文档: https://jsdoc.app/
• Python Docstring规范: https://peps.python.org/pep-0257/
• JavaDoc指南: https://www.oracle.com/java/technologies/javase/javadoc-tool.html