解决代码注释“越写越乱”的问题

曾经写注释很随意，结果过了一个月自己都看不懂。现在我有了固定套路：类注释写清楚功能和依赖的模块；函数注释说明参数含义、返回值和异常场景，比如“@param userId 用户ID，非空”；复杂逻辑处加行内注释，说明“为什么这么写”，而不是“在做什么”。注释要和代码同步更新，改代码时别忘改注释。另外，避免冗余注释，像“int i=0; //定义变量i”这种就没必要写。简洁准确的注释，才是真正有用的。