Java注释规范,很详细,很有用。
Window->Preference-java-editor-templates
可以自己写一些参数~例如 user ---zhongjb
六、工程特有命名规范
1、持久层
1、 Hibernate 映射文件及实体
与数据库表名称完全对应;
如: Advertisement.hbm.xml 、 Advertisement.java
2、数据访问 DAO
DAO 接口和实现类名称必须完全符合正常接口和实现类的命名规则,且最后以 ”DAO” 结尾。DAO 内的数据访问方法必须足够抽象的描述出对数据库的基本 CRUD 操作;
如: ICrossAdDAO( 接口 ) 、 CrossAdDAO( 实现类 )
3、各种操作数据库的 HQL 配置文件
HQL 文件的个数原则上与系统的 Services 层的服务个数相等,且以服务名称命名 HQL 文件;
如: resource.hbm.xml
2、服务层
1、服务接口和实现
服务接口和实现类必须完全符合正常接口和实现类的命名规则;以工程定义的服务名为主体,并统一以 ”Serv” 结尾
如: IResourceServ( 服务接口 ) 、 ResourceServ( 接口实现类 )
2、服务接口方法
方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。
方法名尽可能的描述出该方法的动作行为。
返回类型为 Boolean 值:用“ is ”或“ has ”来开头
得到某数据: get+ 数据描述名词复数 + 数据类型;
得到所有数据: get+All+ 数据描述名词复数 + 数据类型;
通过 XXX 得到 / 查询某数据: get/query+ 数据描述名词复数 + 数据类型 +By+ 条件;
添加某数据: save/add+ 数据描述名词 ()
更新某数据: save/update+ 数据描述名词;
删除某数据: delete/remove+ 数据描述名词;
3、业务对象
Java注释规范整理_IT/计算机_专业资料。Java注释规范Java 注释规范一、背景 1、当我们第一次接触某段代码,但又被要求在极短的时间内有效地分 析这段代码,我们...
java注释书写规范_IT/计算机_专业资料。Java 注释书写规范 Javadoc 是 Sun 公司提供的一个技术,它从程序源代码中抽取类、方法、成 员等注释形成一个和源代码...
java注释规范_IT/计算机_专业资料。javadoc 做注释 一. Java 文档 // 注释一行 /* ... */ 注释若干行 /** ... */ 注释若干行,并写入 javadoc 文档...
java注释规范_IT/计算机_专业资料。JAVA注释规范设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开 Comments 节点就是所有需设置...
Java注释规范_电子/电路_工程科技_专业资料。Java的各种注释,以及写入Javadoc的注释要求对于Java 注释我们主要了解两种: // 注释一行 /* ... */ 注释若干行...
java注释规范_工学_高等教育_教育专区。Java 程序有两类注释:实现注释(implementation comments)和文档注释(document comments)。 实现注释:/*…*/和//,用以注释...
java中的注释规范_IT/计算机_专业资料。java中的注释规范JAVA 注释方法及格式 1、单行(single-line)--短注释://…… 单独行注释:在代码中单起一行注释, 注释...
javadoc注释规范_专业资料。javadoc注释规范javadoc 做注释 一. Java 文档 // 注释一行 注释若干行 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法...
注释模板规范_java_计算机软件及应用_IT/计算机_专业资料。关于java注释模板规范设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后...
热门文档