javacommon程序编写规范

《javacommon程序编写规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、JAVACOMMON工程程序编写规范及操作文档更改记录版本日期修改描述修改者草稿2010-11-15创建bzq1.包、类和方法的命名1.1包的命名一级包名二级包名三级包名四级包名javacommonalgorithm(算法)mdMd加密码算法baseibatis拓展exception自定义异常util主要工具包encoded编码转码http发起HTTP请求ioIo操作jdbc数据库连接log日志处理single单实例string字符串处理time日期时间处理swdlSwdlAJVA转换xmlXML生成解析zip压缩解压表和模块的对应关系会在设计说明书中说明。1.

2、1类和方法的命名类的命名参照java命名规范中的要求:类，接口：由一个或几个单词组成，每个单词的第一个字母大写，比如：StringBuffer类：一般用名词和名词词组命名;IndexOptimizer.java;WebDbReader.java接口：与类相同，可以使用形容词词缀，比如Runnable,Comparable方法：除第一个字母小写外，和类，接口的命名规则一样。比如：getPersonInfo()对于取属性值和设置属性值的方法：不管是否是Bean，都要遵循JavaBean命名规范：getXXX(),setXXX()转换对象类型返回不同类型的方法：命名成

3、toType，比如：toString(),toArray()返回视图的方法：命名成asType()形式，asList()返回与调用此方法的对象（WrapperClass）同值的原始类型的方法：命名成typeValue()形式，比如intValue(),floatValue(),parseCharacterEncoding(String);注：需要遵循，类的用途，通常将用途或功能相近的类放置在一起，命名为类主要解决的问题简单表述。只要其他操作人员在看到该类的时候通过名字大概可以知道该类处理那些问题。1.书写注释1.1Java文档/***show方法的简述.*

4、show方法的详细说明第一行
*show方法的详细说明第二行*@parambtrue表示显示，false表示隐藏*@return没有返回值*/publicvoidshow(booleanb){frame.show(b);}第一部分是简述。文档中，对于属性和方法都是先有一个列表，然后才在后面一个一个的详细的说明简述部分写在一段文档注释的最前面，第一个点号(.)之前(包括点号)。换句话说，就是用第一个点号分隔文档注释，之前是简述，之后是第二部分和第三部分。第二部分是详细说明部分。该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号

5、。*show方法的简述.*

show方法的详细说明第一行
*show方法的详细说明第二行简述也在其中。这一点要记住了第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。*@parambtrue表示显示，false表示隐藏*@return没有返回值1.2使用javadoc标记javadoc标记由“@”及其后所跟的标记类型和专用注释引用组成javadoc标记有如下一些：@author标明开发该类模块的作者@version标明该类模块的版本@see参考转向，也就是相关主题@param对方法中某参数的说明@return对方法返回值的说明@exc

6、eption对方法可能抛出的异常进行说明@author作者名@version版本号其中，@author可以多次使用，以指明多个作者，生成的文档中每个作者之间使用逗号(,)隔开。@version也可以使用多次，只有第一次有效使用@param、@return和@exception说明方法这三个标记都是只用于方法的。@param描述方法的参数，@return描述方法的返回值，@exception描述方法可能抛出的异常。它们的句法如下：@param参数名参数说明@return返回值说明@exception异常类名说明1.1类、接口注释类、接口的注释采用/**…*/，描述

7、部分用来书写该类的作用或者相关信息，块标记部分必须注明作者和版本。例如：/**Title:XXXXDRIVER3.0*Description:XXXXDRIVER3.0*Copyright:Copyright(c)2003*Company:XXXX有限公司**@authorJavaDevelopmentGroup*@version3.0*/例如：/***Aclassrepresentingawindowonthescreen.*Forexample:**Windowwin=newWindow(parent);*win.show();***@authorSamiS

8、haio*@versio