首页 诗词 字典 板报 句子 名言 友答 励志 学校 网站地图
当前位置: 首页 > 教程频道 > 开发语言 > 编程 >

代码诠释

2012-12-20 
代码注释转载:摘抄自http://zhang-xzhi-xjtu.iteye.com/blog/968591?1、注释不是为了满足规范和要求,而要体

代码注释

转载:摘抄自http://zhang-xzhi-xjtu.iteye.com/blog/968591

?

1、注释不是为了满足规范和要求,而要体现注释的作用和价值。

2、良好的命名取代不必要的注释。

3、多写为什么的注释,而不是做了什么的注释。what而非why,why是应该通过代码体现的,代码自注释。

4、注释的维护。

5、方法里面出现重复注释的时候,应该抽取方法级别的详尽注释到类,便于方法改动时修改相应的注释。

6、注释过长,可以考虑将注释放在测试类中。

热点排行