驼峰命名法驼峰命名法路飞博客

驼峰命名法

1、取词:选择有意义的名字,能快速地传达该词的用途

2、包命名:所有包的命名必须采用小写英文字母

3、类命名:所有单词首字母大写,其中xxx为模块名称。

    1)、Dao层

        a、接口类采用JavaBean+Interface+Dao的形式来定义,即,实体对象+Interface+Dao。如:用户对象接口类: UserInterfaceDao。

        b、实现类:采用JavaBean+Interface+Impl+Dao的形式来定义,即,实体对象 +Interface+Impl+Dao。 如:用户对象实现类:UserInterfaceImplDao

    2)、Service层

        a、接口类:采用Xxx+Interface+Service的形式来定义,即,模块+Interface+Service。如:用户管理接口类:UserMsgInterfaceServiec

        b、实现类:采用Xxx+Interface+Impl+Service的形式来定义,即,模块+Interface+Impl+Service。如:用户管理实现类:UserMsgInterfaceImplServiec

    3)、Web层(action类)

        a、实现类:采用县 Xxx+Operator+Action的形式来定义,即,模块+操作+Action。如用户模块User+删除操作Delete+Action = UserDeleteAction

4、方法命名:首字母以小写开头,其他单词首字母大写

5、变量命名:

    a、普通变量:首字母以小写开头,其他单词首字母大写 定义一个整形变量:intDocCount,其中int表明数据类型,后面为表意的英文名,每个单词首字母大写。 

    b、静态变量:采用全部大写的形式来书写,对于采用多词合成的变量采用“_”来连接各单词。如:USER_LIST 6、注释的书写(Javadoc) 

    a、以/**开头,而以*/结束, Javadoc 注释可以被自动转为在线文档,省去了单独编写程序文档的麻烦。

    b、Javadoc注释主要涉及范围:类、属性、方法。

7、Jsp页面名称的命名 

    a、全部采用小写的英文字符和”_ ”组成。   

    b、整体采用模块名+操作的形式。如:user_view.jsp 

    c、Jsp页面尽可能与action的意思对应,如UserListAction 对应者user_list.jsp

说明: 

接口: 使用驼峰式命名。除了用名词外,还可以用形容词命名(体现其功能特性) 

方法: 规定用动词命名,适合用驼峰式命名,但与类名的最大区别在于,首字母必须小写

变量: 规定为名词,其他同“方法”命名方式一样。变量名非常关键,应含有具体意义且易于理解,一般不允许使用单个字母做变量 名。除非一些临时性变量,像在循环中使用到的计数器等。在使用单个字母做变量名时,一般I、J、K用来命名整形变量。

常量: 规定全用大写字母表示,如果名字必须用多个单词来表示,那么各单词间用“-“分隔。常量要求必须意义明确,能表达出常量的含义。

转载请注明:路飞博客 » 驼峰命名法