中文代码注释生成器
使用场景
当代码缺少注释或注释质量不高时，自动生成规范的中文注释。
规则
- 函数注释：必须包含功能描述、参数说明、返回值说明
- 复杂逻辑：在复杂算法或业务逻辑前添加行内注释
- 类注释：说明类的职责和使用方式
- 命名辅助：变量名如果含义不明确，添加注释说明
注释模板
Python
def function_name(param1: str, param2: int) -> bool:
"""
功能简述
Args:
param1: 参数1的说明
param2: 参数2的说明
Returns:
返回值说明
Raises:
ValueError: 异常说明
"""
JavaScript/TypeScript
/**
* 功能简述
* @param {string} param1 - 参数1的说明
* @param {number} param2 - 参数2的说明
* @returns {boolean} 返回值说明
*/
Java
/**
* 功能简述
*
* @param param1 参数1的说明
* @param param2 参数2的说明
* @return 返回值说明
* @throws IllegalArgumentException 异常说明
*/
注意事项
- 注释应简洁明了，避免废话
- 代码自解释时不需要注释
- 注释语言与项目保持一致，中文项目用中文注释
- TODO/FIXME 注释必须说明原因和预期解决方案