posts - 104,  comments - 34,  trackbacks - 0
 

定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性)。

Java 的语法与 C++ 及为相似,那么,你知道 Java 的注释有几种吗?是两种?   

// 注释一行  

/* ...... */ 注释若干行

不完全对,除了以上两种之外,还有第三种,文档注释:   

/** ...... */ 注释若干行,并写入 javadoc 文档

 


1、注释要简单明了。

String userName = null; //用户名

2、边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。

3、在必要的地方注释,注释量要适中。注释的内容要清楚、明了,含义准确,防

止注释二义性。保持注释与其描述的代码相邻,即注释的就近原则。

4、对代码的注释应放在其上方相邻位置,不可放在下面。对数据结构的注释应放在

其上方相邻位置,不可放在下面;对结构中的每个域的注释应放在此域的右方;

同一结构中不同域的注释要对齐。


5、变量、常量的注释应放在其上方相邻位置或右方。


6、全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以

及存取时注意事项等的说明。


7、在每个源文件的头部要有必要的注释信息,包括:文件名;版本号;作者;生成日

期;模块功能描述(如功能、主要算法、内部各部分之间的关系、该文件与其它文

件关系等);主要函数或过程清单及本文件历史修改记录等。

/**
   * Copy Right Information   : Neusoft IIT
   * Project                        : eTrain
   * JDK version used           : jdk1.3.1
   * Comments                  : config path
   * Version                       : 1.01
   * Modification history     :2003.5.1
   * Sr Date   Modified By   Why & What is modified
   * 1. 2003.5.2 Kevin Gao     new
   **/

8、在每个函数或过程的前面要有必要的注释信息,包括:函数或过程名称;功能描

述;输入、输出及返回值说明;调用关系及被调用关系说明等

 

 /**
      * Description :checkout 提款
      * @param Hashtable cart info
      * @param OrderBean order info
      * @return String
      */
     public String checkout(Hashtable htCart, OrderBean orderBean) throws Exception
     { }

9、javadoc注释标签语法

@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向,也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明

posted on 2010-08-05 11:30 末日风情 阅读(1267) 评论(0)  编辑  收藏 所属分类: java编程

只有注册用户登录后才能发表评论。


网站导航:
 
<2010年8月>
25262728293031
1234567
891011121314
15161718192021
22232425262728
2930311234

常用链接

留言簿(4)

随笔分类

随笔档案

搜索

  •  

最新评论

阅读排行榜

评论排行榜