默认它会写「// 这里判断是否为空」这种废话。
明确要求:只在三种情况下写注释——
- 为什么这么写(不明显的取舍)
- 为什么不能用更直接的写法(踩过的坑)
- 外部约束(业务规则、协议要求)
禁止写:函数作用、参数说明(这些从名字能看出来)。
改完之后注释量少了七成,可读性反而提高。
顺带发现:让它写「为什么」的时候,它会暴露一些我没想清楚的地方。
主楼- 暂无回复
继续逛逛
默认它会写「// 这里判断是否为空」这种废话。
明确要求:只在三种情况下写注释——
禁止写:函数作用、参数说明(这些从名字能看出来)。
改完之后注释量少了七成,可读性反而提高。
顺带发现:让它写「为什么」的时候,它会暴露一些我没想清楚的地方。