java命名和注释原则

1.jsp命名规则:
    新增:_new
    编辑:_edit
    查看:_view
    列表:_list
    详细:_info
    审批:_audit
    确认:_confirm

2.包的命名:包名全小写
    持久类:.dao及实现类.impl
    实体类:.entity(pojo)
    工具类:.utils
    业务类:.biz(.service)
    通信类:.net
    配置文件:.config
    映射文件:.mapping

3.类和接口的命名
    1.类和接口每个单词首字母全大写
    2.Javabean类均以说明形式,如User、Customer
    3.dao、biz、utils,均在类名最后加上对应的,如UserDao、StringUtil
    4.dao的impl、biz的impl,均在类后面加上 “对应包+Impl”,如UserDaoImpl

4.变量的命名:
1.变量尽量使用英文,但绝对不要用拼音,可以有道翻译一下,然后拿来当变量名
2.常量全大写,如MAX_SIZE
3.全局变量(成员变量)驼峰式命名或者每个单词都小写中间"_"分开
4.静态变量全大写

5.方法的命名:
1.方法名以小写字母开头,以后每一个单词首字母大写(驼峰式命名)
2.没有必要重复类的名字。例如Customer有一个方法是提取顾客的名字,我们把方法命名为getName(),而不是getCustomer()
3.当一个方法调用当前类的方法时,需明确使用“this.+methodName()”来强调自己类里的方法
4.根据方法功能命名
    1.get*:获取数据
    2.find*:检索数据
    3.load*:载入数据
    4.insert*:添加数据
    5.delete*:删除数据
    6.update*:修改数据
    7.save*:保存新修改数据

6.项目命名:全小写,域名+项目名称

7.数据库命名:数据库表和字段全大写

8.注释原则:
1.类注释:在每个类加上类注释,注释模板如下:

/**

* Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.

* FileName: Test.java

* 类的详细说明

*

* @author 类创建者姓名

* @Date 创建日期

* @version 1.00

*/

2.属性注释:在每个属性加上属性注释,模板如下:

/** 提示信息 */

private String strMsg = null;


3.方法注释:在每个方法加上方法注释,模板如下:

/**

* 类方法的详细使用说明

*

* @param 参数 1 参数 1的使用说明

* @return 返回结果的说明

* @throws 异常类型 . 错误代码 注明从此类方法中抛出异常的说明 */



4.构造方法注释:在每个构造方法加上构造方法注释,模板如下:
            /**

* 构造方法的详细使用说明

*

* @param 参数 1 参数 1的使用说明

* @throws 异常类型 . 错误代码 注明从此类方法中抛出异常的说明 

*/

5.方法内部注释:方法内部用单行或多行注释,如

//背景颜色

Color bgColor = Color.RED



猜你喜欢

转载自blog.csdn.net/qq_33719636/article/details/80328097