2014程序编写规.docVIP

JAVACOMMON工程 程序编写规范及操作 文档更改记录 版本 日期 修改描述 修改者 草稿 2010-11-15 创建 bzq 包、类和方法的命名 包的命名 一级包名 二级包名 三级包名 四级包名 javacommon algorithm (算法) md Md加密码算法 base ibatis拓展 exception 自定义异常 util 主要工具包 encoded 编码转码 http 发起HTTP请求 io Io操作 jdbc 数据库连接 log 日志处理 single 单实例 string 字符串处理 time 日期时间处理 swdl Swdl AJVA 转换 xml XML 生成解析 zip 压缩解压 表和模块的对应关系会在设计说明书中说明。 类和方法的命名 类的命名参照java命名规范中的要求: 类，接口：由一个或几个单词组成，每个单词的第一个字母大写，比如：StringBuffer 类：一般用名词和名词词组命名; IndexOptimizer.java; WebDbReader.java 接口：与类相同，可以使用形容词词缀，比如 Runnable, Comparable 方法：除第一个字母小写外，和类，接口的命名规则一样。比如：getPersonInfo() 对于取属性值和设置属性值的方法：不管是否是 Bean，都要遵循 JavaBean 命名规范：getXXX(), setXXX() 转换对象类型返回不同类型的方法：命名成 toType，比如：toString(), toArray() 返回视图的方法：命名成 asType() 形式，asList() 返回与调用此方法的对象（Wrapper Class）同值的原始类型的方法：命名成 typeValue() 形式，比如 intValue(), floatValue(),parseCharacterEncoding(String); 注：需要遵循，类的用途，通常将用途或功能相近的类放置在一起，命名为类主要解决的问题简单表述。只要其他操作人员在看到该类的时候通过名字大概可以知道该类处理那些问题。 书写注释 Java 文档/** * show 方法的简述. * pshow 方法的详细说明第一行br * show 方法的详细说明第二行 * @param b true 表示显示，false 表示隐藏 * @return 没有返回值 */ public void show(boolean b) { frame.show(b); } 第一部分是简述。文档中，对于属性和方法都是先有一个列表，然后才在后面一个一个的详细的说明 简述部分写在一段文档注释的最前面，第一个点号 (.) 之前 (包括点号)。换句话说，就是用第一个点号分隔文档注释，之前是简述，之后是第二部分和第三部分。 第二部分是详细说明部分。该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。 * show 方法的简述. * pshow 方法的详细说明第一行br * show 方法的详细说明第二行 简述也在其中。这一点要记住了 第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。 * @param b true 表示显示，false 表示隐藏 * @return 没有返回值 使用 javadoc 标记 javadoc 标记由“@”及其后所跟的标记类型和专用注释引用组成 javadoc 标记有如下一些： @author 标明开发该类模块的作者 @version 标明该类模块的版本 @see 参考转向，也就是相关主题 @param 对方法中某参数的说明 @return 对方法返回值的说明 @exception 对方法可能抛出的异常进行说明 @author 作者名 @version 版本号 其中，@author 可以多次使用，以指明多个作者，生成的文档中每个作者之间使用逗号 (,) 隔开。@version 也可以使用多次，只有第一次有效 使用 @param、@return 和 @exception 说明方法 这三个标记都是只用于方法的。@param 描述方法的参数，@return 描述方法的返回值，@exception 描述方法可能抛出的异常。它们的句法如下： @param 参数名 参数说明 @return 返回值说明 @exception 异常类名 说明 类、接口注释类、接口的注释采用 /** … */，描述部分用来书写该类的作用或