java项目代码命名规范 java项目代码命名规范要求

使用Java作为程序语言时，好的命名规范有哪些

Package 的命名

创新互联建站是一家朝气蓬勃的网站建设公司。公司专注于为企业提供信息化建设解决方案。从事网站开发，网站制作，网站设计，网站模板，微信公众号开发，软件开发，微信小程序，十年建站对广告设计等多个行业，拥有多年的网站推广经验。

Package 的名字应该都是由一个小写单词组成。

Class 的命名

Class 的名字必须由大写字母开头而其他字母都小写的单词组成

Class 变量的命名

变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。

Static Final 变量的命名

Static Final 变量的名字应该都大写，并且指出完整含义。

参数的命名

参数的名字必须和变量的命名规范一致。

数组的命名

数组应该总是用下面的方式来命名:

byte[] buffer;

而不是:

　byte buffer[];

方法的参数

使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字:

SetCounter(int size){

this.size = size;

}

变量名

普通变量命名应该采用首字母小写，其他字母首字母大写的方式。

final static变量的名字应该都大写，并且指出完整含义。如果一个常量名称由多个单词组成，则应该用下划线来分割这些单词如。

NUM_DAYS_IN_WEEK MAX_VALU

如果需要对变量名进行缩写时，一定要注意整个代码中缩写规则的一致性

context=ctx message=msg

通过在结尾处放置一个量词，就可创建更加统一的变量

First(一组变量中的第一个) Last(一组变量中的最后一个) Next(一组变量中的下一个变量) Prev(一组变量中的上一个) Cur(一组变量中的当前变量)

无论什么时候，均提倡应用常量取代数字、固定字符串。也就是说，程序中除0，1以外，尽量不应该出现其他数字。

索引变量：i、j、k等只作为小型循环的循环索引变量。

逻辑变量：避免用flag来命名状态变量，用is来命名逻辑变量。

if(isClosed){ dosomeworks; return; }

数组

总是使用以下方式定义数组：

int[] arr = new int[10];

禁止使用C语言的是形式：

禁止 int arr[] = new int[10];

集合

数组或者容器推荐命名方式为名词+s的方式，例如：

　List persons = getPerson(); for(Person person : persons){ dosomeworks; }

泛型

应该尽量简明扼要(最好是一个字母)，以利于与普通的class或interface区分

Container中的Element应该用E表示;Map里的key用K表示，value用V;Type用T表示;异常用X表示

如果需要接收多个Type类型的参数，应该用邻接T的大写字母——例如S——来依次表示，当然也可以用T1, T2这样的方式

public class HashSet extends AbstractSet {…} public class HashMapextends AbstractMap {…} public class ThreadLocal {…} public interface Functor { T val() throws X; }

推荐的命名

1.当要区别接口和实现类的时候，可以在类的后面加上“Impl”。

interface Container class ContainerImpl

2.Exception类最好能用“Exception”做为类命名的结尾

DataNotFoundException InvalidArgumentException

3.抽象类最好能用“Abstract”做为类命名的开头

AbstractBeanDefinition AbstractBeanFactory

4. Test类最好能用“Test”做为类命名的结尾

ContainerTest

5.简称与缩写(不推荐使用)

cp代表colorPoint buf代表buffer off代表offset len代表length

除非是在循环中，否则一般不推荐使用单个字母作为变量名，不过也有例外，即约定俗成的单个字母

b代表byte c代表char d代表double e代表Exception f代表float i, j, k代表整数 l代表long o代表Object s代表String v代表某些类型的特定值

代码风格

花括号

花括号统一采用以下格式：

if(bool experssion){ dosomework; }

除非花括号中为空，不然任何情况下不能省略花括号，并且花括号必须换行，例如：

if(i==0){ return; } while(true) {}

以下写法禁止出现：

禁止 if(i != 0) return; 禁止 if(i !=0) {return;}

括号

括号的前，后一个字符不需要空格，例如：

　Person p = new Person(“Jack”， 17);

空格

逗号之后紧跟一个空格。

Person p = new Person(“Jack”， 16, “China”);

二元操作符前后跟空格。

int i = a + b – c * d;

3. 一元操作符不需要空格，for语句分号后有空格。

for(int i = 0; I 10; i++){ dosomework; }

4. 括号前后不需要空格

类

类的定义结构按照顺序为：

1) 常量

2) 成员变量

3) 构造函数

4) 成员函数

5) get和set方法

各个部分之间留出一个空行。

例如：

规范类模板：

class Person{ private final static int MAX_AGE = 100; private String firstname = “Jack”; public Person(){} public Person(String firstname){ this.firstname = firstname; } public void doExercise(){ dosomeworks; run(); } private void run(){ dosomeworks; } public getFirstname(){ return firstname; } public setFirstname(String firstname){ this.firstname = firstname; } }

2.构造函数

1) 参数为空的构造函数出现在最上方

2) 有调用关系的构造函数相邻

3) 参数尽量由少到多从上至下排序

3.使用成员变量

在类的方法内引用成员变量了命名冲突以外，不使用this。非特殊情况在类的方法内都不使用get和set方法存取成员变量。

4.方法

有调用关系的方法尽量放在相邻的位置，public和private方法可以交叉放置。

5.get和set方法，所有需要公开的成员变量都要符合良好的javabean规范，提供get和set方法，尽量使用IDE工具自动生成。

Javadoc注释

在每个程序的最开始部分，一般都用Javadoc注释对程序的总体描述以及版权信息，之后在主程序中可以为每个类、接口、方法、字段添加 Javadoc注释，每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能，这句话应单独占据一行以突出其概括作用，在这句话后面可以跟随更加详细的描述段落。在描述性段落之后还可以跟随一些以Javadoc注释标签开头的特殊段落，例如上面例子中的@auther和@version，这些段落将在生成文档中以特定方式显示

Java类的命名规则是什么

1．使用完整描述符来准确地描述变量、字段或类。

例如，使用的名称可以是 FirstName、GrandTotal 或 Corporate Customer。虽然像 x1、y1 或 fn 这样的名称较短容易输入，但是它们并不提供任何信息指出它们所代表的内容。这样对代码的理解、维护和增强会造成一定困难。

2．使用适用于领域内的术语。

如果您的用户将他们的客户称为顾客，则对这个类使用术语Customer来代替Client。许多开发人员曾经犯了这样一个错误：当业界或领域中已存在更贴切的术语时，他们还冥思苦想，准备为一些概念创建通用术语。

3．巧妙节俭地使用缩写。

这表示您应该维护一份标准短格式（缩写）的列表，应该明智地选择它们，并在使用时保持一贯性。例如，如果要使用字 arithmetic 的短格式， 选择 ar、ari 或 art 中的一个，记录下所选的缩写（到底是哪个并不重要），并只使用这一个。

4．使用大小写混合增强名称的可读性。

通常应该使用小写字母，但是将类名和接口名称的第一个字母写成大写，将所有非起始单词的第一个字母也写成大写。

5．将标准首字母缩写词的第一个字母大写。

名称会经常包含标准缩写，如 SQL 表示“Standard Query Language”。诸如表示属性的 sqlDatabase 或表示类的 sQLDatabase 等名称比sQLDatabase 和SQLDatabase 更便于阅读。

6．避免长型名称（最大 15 个字符比较合适）。

虽然类名 AllImplemented IterfacesAndSubclass 可能是个比较好的类名（当然，在此示例中有些夸张），但是这个名称显然太长，应该把它重命名为较短的名称才好。

7．避免名称过于相似或仅在大小写方面有区别。

不应该同时使用变量名 myObject 和 myObjects，也不应该同时使用 myOraDatabase 和 anORADatabase。

扩展资料：

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)、坚决不允许出现中文及拼音命名。

参考资料：百度百科-Java

java web项目中，模块的命名规则是什么？

servlet类所在包命名规范：域名类型.域名.项目名称.web.servlet

例如：com.baidu.web.servlet

自定义标签类所在包命名规范：域名类型.域名.项目名称.web.tags

例如：com.baidu.web.tags

过滤器类所在包命名规范：域名类型.域名.项目名称.web.filter

例如：com.baidu.web.filter

Action类所在包命名规范：域名类型.域名.项目名称.web.action

例如：com.baidu.web.action

ActionForm类所在包命名规范：域名类型.域名.项目名称.web.form

例如：com.baidu.web.form

Javabean所在包命名规范：域名类型.域名.项目名称.web.service.impl

例如：com.baidu.web.service.impl

Javabean实现接口命名规范：域名类型.域名.项目名称.web.service

例如：com.baidu.web.service

DAO类所在包命名规范：域名类型.域名.项目名称.dao.impl

例如：com.baidu.dao.impl

DAO类所实现的接口在包中命名规范：域名类型.域名.项目名称.dao

例如：com.baidu.dao

POJO类与hbm文件所在包命名规范：域名类型.域名.项目名称.dao.hbm

例如：com.baidu.dao.hbm

全局公共类、接口类所在包命名规范：域名类型.域名.项目名称.global

例如：com.baidu.global

全局工具类所在包命名规范：域名类型.域名.项目名称.util

例如：com.baidu.util

Java中类的命名规范是怎样的？

在java中，自有一套命名规则，下面我就大概的说一下,希望对你能有用. \x0d\x0a包名：包名是全小写的名词，中间可以由点分隔开，例如：java.awt.event; \x0d\x0a\x0d\x0a类名：首字母大写，通常由多个单词合成一个类名，要求每个单词的首字母也要大写，例如class HelloWorldApp; \x0d\x0a\x0d\x0a接口名：命名规则与类名相同，例如interface Collection; \x0d\x0a\x0d\x0a方法名：往往由多个单词合成，第一个单词通常为动词，首字母小写，中间的每个单词的首字母都要大写，例如：balanceAccount， \x0d\x0aisButtonPressed; \x0d\x0a\x0d\x0a变量名：全小写，一般为名词，例如：length; \x0d\x0a\x0d\x0a常量名：基本数据类型的常量名为全大写，如果是由多个单词构成，可以用下划线隔开，例如：int YEAR, int \x0d\x0aWEEK_OF_MONTH；如果是对象类型的常量，则是大小写混合，由大写字母把单词隔开。

java项目中项目名称、模块名称、目录名称、文件名称的命名规范是啥？

java类名是驼峰命名，即单词首字母大写，其他字母小写，其他看要求，目录一般都是小写，一般命名是和当前业务相关的英文单词。