java注代码的13技巧.docVIP

HYPERLINK /beijiguangyong/article/details/5421648 释代码的13技巧 2010-03-27 02:14 486人阅读 HYPERLINK /beijiguangyong/article/details/5421648 \l comments#comments 评论(0) HYPERLINK javascript:void(0); \o 收藏 收藏 HYPERLINK /beijiguangyong/article/details/5421648 \l report#report \o 举报 举报 。 1. Comment each level（每个级别的注释有统一的风格） 注释每一个代码块，并且在各个级别的代码块上，要使用统一的注释方法。例如： 对于类，应包含简单的描述、作者以及最近的更改日期 对于方法，应包含目的的描述、功能、参数以及返回值 使用统一的注释规则对于一个团队是非常重要的。当然，更加推荐使用注释的约定和工具（例如，C#的XML或Java的Javadoc），它们会是注释变得更加容易。 2. Use paragraph comments（对段落注释） 将代码块分成若干完成独立功能的段落，并在每个段落前添加注释，向读者说明即将发生什么。 // Check that all data records // ar