Java项目命名规范(简洁版)——高薪必看

作为一个优秀的项目经理或项目带头人,必须养成良好优秀的项目命名规则和习惯。接下来把查到的资料整理一下,实际上,在很多项目中,也是遵循以下的规则。

一、项目名

全部小写,比如cms、workdesk,jobserver等

二、java相关命名

a、类命名:每音节单词前的第一个字母大写,比如FieldInfo、Expression等\

b、普通变量(包括spring里的变量引用命名):第一个单词前小写,以后每个单词第一个字母大写,password,primaryFlag

c、静态变量:全部大写,多个单词则以_分开,比如BOOLEAN_FLAG

d、包package命名:全部小写,比如com.joinspider.workdesk

补充:

a、类名、变量名是名字组合,多名词顺序和中文顺序一样,比如ScriptEngine

b、属性也可以是形容词+名词

c、常量可使用上述规则,如果为了体现多个常量是一组的概念,也可以被修饰前置,

比如:VAR_START,VAR_END.

c、方法是动词+名字或者只有动词

三、属性文件.properties定义变量命名

object.a_b_c格式,全部小写,其中object是宿主,a_b_c多个单词下划线分开。

例:hibernate.cache.use_second_level_cache,hibernate.cache.provider_class,hibernate.cache.provider_configuration_file_resource_path

四、xml文件命名

全部小写,-符号是其xml的用途说明,类似applicationContext属习惯命名。比如springmvc-servlet.xml、workdesk-manager.xml、workdesk-servlet.xml、applicationContext-basic.xml等

xml里的内容多个字符间以-隔开,比如param-name,filter-mapping等

五、普通文件命名(jsp,js,img等)

和java普通变量规范相同

六、属性文件properties

以下划线隔开:errors_zh_CN.properties,hibernate_test.properties

六、数据库命名:

表、字段命名全部大写,多个单词以_隔开

附加Java命名规范

一、命名规范

1、 项目名全部小写

2、 包名全部小写

3、 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写。

如:public class MyFirstClass{}

4、 变量名、方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写。

如:int index=0;

public void toString(){}

5、 常量名全部大写

如:public static final String GAME_COLOR=”RED”;

6、所有命名规则必须遵循以下规则:

1)、名称只能由字母、数字、下划线、$符号组成

2)、不能以数字开头

3)、名称不能使用JAVA中的关键字。

4)、坚决不允许出现中文及拼音命名。

二、注释规范

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

时间: 2024-08-06 04:45:58

Java项目命名规范(简洁版)——高薪必看的相关文章

java项目命名规范

一.命名规范 1. 项目名全部小写 2. 包名全部小写 3. 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写. 如:public class MyFirstClass{} 4. 变量名.方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写. 如:int index=0; public void toString(){} 5. 常量名全部大写 如:public static final String GAME_COLOR="RED"; 6.所有命名规则必须

Java 项目命名规范

规范概览 对于一个标准的项目来说,目录名.包名.类名.方法名.变量名,这些名称都有一个大致的规范. 名称 规范 包名 公司域名倒写 数据访问层 dao.persist.mapping.mapper 实体类 entity.model.bean.javabean 业务逻辑 service.biz 控制器 controller.servlet.action.web 过滤器 filter 监听器 listener 异常 exception 类名和方法名的注释 /**     */ 方法内部的注释 /* 

java开发命名规范(转载)

java开发命名规范 使用前注意事项: 1.  由于Java面向对象编程的特性, 在命名时应尽量选择名词 2.  驼峰命名法(Camel-Case): 当变量名或函式名是由一个或多个单字连结在一起,而构成的唯一识别字时,首字母以小写开头,每个单词首字母大写(第一个单词除外). 如:myFirstName 一 包名的书写规范 (Package) 推荐使用公司或机构的顶级域名为包名的前缀,目的是保证各公司/机构内所使用的包名的唯一性.包名全部为小写字母,且具有实际的区分意义. 1.1 一般要求 1.

Java的命名规范(转载)

Java是一种区分字母的大小写(case-sensitive)的语言,下面谈谈Java语言中包.类.变量等的命名规范. (一)Package(包)的命名: Package的名字应该都是由一个小写单词组成,例如net.ebseries.modules. (二)Class(类)的命名: Class的名字首字母大写,通常由多个单词合成一个类名,要求每个单词的首字母也要大写,例如:DataFile或InfoParser. (三)变量的命名: 变量的名字可大小写混用,但首字符应小写.词由大写字母分隔,限制

项目命名规范(二)

项目命名规范 1.文件夹命名 1).最好用一个单词描述 常用项目命名 omi.element.master.project.test.vue.iview 二级目录 build.static.config.src.examples.base.common.issues.assert 三级目录 libs.models.plugins.skins.images.css.js 2).如果一个单词描述不了,用2个词(名词加动词) color-pick.button-groups.date-picker.o

2017——我们为什么选择JAVA?JAVA的发展方向和学习方法(必看)

2017--我们为什么选择JAVA?JAVA的发展方向和学习方法(必看) 原文地址:https://www.cnblogs.com/straybirds/p/8319542.html

java开发命名规范

定义规范的目的是为了使项目的代码样式统一,使程序有良好的可读性. 良好的习惯也有助于我们的成长.今天和大家一起整理下,java在开发过程中语言的规范写法. 使用前注意事项: 1.  由于Java面向对象编程的特性, 在命名时应尽量选择名词 2.  驼峰命名法(Camel-Case): 当变量名或函式名是由一个或多个单字连结在一起,而构成的唯一识别字时,首字母以小写开头,每个单词首字母大写(第一个单词除外). 如:myFirstName 一 包名的书写规范 (Package) 推荐使用公司或机构的

Java开发命名规范总结

个人觉得写代码也是一种艺术,整齐规范的代码,无论是对开发人员,还是后期的维护人员,都是很重要的.以下的内容来自于别人的博客. 链接:http://www.jb51.net/article/42353.htm ============================================ 包名的书写规范 (Package)推荐使用公司或机构的顶级域名为包名的前缀,目的是保证各公司/机构内所使用的包名的唯一性.包名全部为小写字母,且具有实际的区分意义. 使用前注意事项:1.由于Java面向

Java的命名规范

1.类名.接口名:首单词的第一个字母要大写.如果有多个单词,其他单词的首字母要大写. 2.包名:全部小写. 3.变量名.方法名:首单词的第一个字母小写.如果有多个单词,其他单词的首字母要大写. 4.常量名:全部大写,如果有多个单词,那么使用下划线连接. ps: java中包的命名规范详细说明:(为什么要补充这个嘞?因为我过去上课时一直不明白老师为什么用com开头,而且还包含那么多的".".) 1.包名的"."就好像是目录一样,顺着看下去就会很方便地知道对应的clas