注释:
1、尽量用代码来阐述
//check to see if the empoyee is eligible for full benefits
if((employee.flags & HOURLY_FLAG) && (employee.age > 65))
还是这个
if(employee.isEligibleForFullBeenefits())
2、保留警告性的注释
3、日志式、重复性、冗余的、误导性的注释删掉
//the day of the month
private int dayOfMonth
如果一个变量(或者方法名)还需要注释来说明,那么这个变量(或者方法名)的命名肯定不是最合适的,不应该是添加注释,而是重命名。当然,必要的算法思想解释型注释除外。
4、注释应该是言简意赅,如果注释本身还需要解释,那可以删掉了。