导航:首页 > 编程语言 > 阿里java命名规范

阿里java命名规范

发布时间:2023-08-19 18:22:11

A. 使用java作为程序语言时,好的命名规范有哪些

  1. Package的命名

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

    Class的命名

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

    Class变量的命名

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

    StaticFinal变量的命名

    StaticFinal变量的名字应该都大写,并且指出完整含义。

  2. 参数的命名

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

    数组的命名

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

    byte[]buffer;

    而不是:

    bytebuffer[];

    方法的参数

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

    SetCounter(intsize){

    this.size=size;

    }

  3. 变量名

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

    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的方式,例如:

    Listpersons = 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 HashSetextends 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方法

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

例如:

  1. 规范类模板:

  2. 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; } }

  3. 2.构造函数

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

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

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

  7. 3.使用成员变量

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

  9. 4.方法

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

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

  12. Javadoc注释

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

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

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

C. 求Java项目名的命名规范!

我经过资料的搜索, 以及个人实践, 建议采用PascalCase.

以下是我个人对Java命名的方方面面的总结:

NamingConvention
0)Project
单词首字母大写,即PascalCase
BillSystem
170213_JQueryDemo//一般我会在项目名前加上日期,便于在文件系统中能按照时间排序.

1)Package:
全部小写
com.sina.is
e.bdqn.u2

2)Class/Interface:
首字母大写,每个单词的首字母都大写,尽量避免缩写,除非这些缩写用得比原始单词还广泛得多,比如URL,HTTP.
StudentDao
StudentDaoImpl
StudentServlet

3)Methods:
service();
getsNo();
setAddress();

4)Variables:
simpleandexplicit,concise,correct,clear,camelCase.
datetime
unit
itemName

D. java web项目中,模块的命名规则是什么

servlet类所在包命名规范:域名类型.域名.项目名称.web.servlet
例如:com..web.servlet
自定义标签类所在包命名规范:域名类型.域名.项目名称.web.tags

例如:com..web.tags
过滤器类所在包命名规范:域名类型.域名.项目名称.web.filter

例如:com..web.filter
Action类所在包命名规范:域名类型.域名.项目名称.web.action

例如:com..web.action
ActionForm类所在包命名规范:域名类型.域名.项目名称.web.form

例如:com..web.form
Javabean所在包命名规范:域名类型.域名.项目名称.web.service.impl

例如:com..web.service.impl
Javabean实现接口命名规范:域名类型.域名.项目名称.web.service

例如:com..web.service
DAO类所在包命名规范:域名类型.域名.项目名称..impl

例如:com...impl
DAO类所实现的接口在包中命名规范:域名类型.域名.项目名称.

例如:com..
POJO类与hbm文件所在包命名规范:域名类型.域名.项目名称..hbm

例如:com...hbm
全局公共类、接口类所在包命名规范:域名类型.域名.项目名称.global

例如:com..global
全局工具类所在包命名规范:域名类型.域名.项目名称.util

例如:com..util

E. Java中类的命名规范

一、Java程序,包名:Package的名字应该都是由小写单词组成,如:text.demo.example
具体的示例如下:
com.icss下面为平台包。stmacmbas为本项目的根程序包。
stmacmbas.base为本项目的开发基础包。
stmacmbas.commerce为商业企业程序包。
stmacmbas.example为示例程序包。
stmacmbas.instry为工业企业程序包。
stmacmbas.stma为国家局程序包。
stmacmbas.util为工具包。

二、文件名。
1. 文件名由英文单词组成,每个单词的首字母大写,最好不要超过4个单词,如:ShipOrder.java。
2. Java文件的文件名要与程序中的public类名相同。
3. Servlet文件要以Servlet作为结尾,如:AddCompanyServlet.java。

三、类名:每个单词的首字母大写。同上。

四、变量名。
1. class变量的命名:变量的名字必须用一个小写字母开头,后面的单词用大写字母开头。
2. static final变量的命名:static final变量的名字应该都大写并且指出完整含义。
3. 用有意义的名字命名变量:首先,用完整的英语单词或约定俗成的简写命名变量(不允许用汉语拼音),如:firstName,zipCode。
4. 用复数命名Collection类变量。Collection包括数组,vector等。命名时使用复数:customers, classmates。

五、方法名。
1. 方法的名字必须用一个小写字母开头,后面的单词用大写字母开头。
2. 方法的名字要与该方法的用途相关。

六、参数名。
1. 参数的命名:参数的名字必须和变量的命名规范一致。
2. 方法的参数:使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字。

阅读全文

与阿里java命名规范相关的资料

热点内容
迅雷影音文件夹 浏览:109
makefile的文件路径 浏览:392
计算机程序文件名扩展名为 浏览:982
网络游戏推广策划案 浏览:609
替换所有文件内容的代码 浏览:960
不是常用数据模型有哪些 浏览:426
aspcms版本号 浏览:835
安卓怎么用数据流量下载软件 浏览:553
大众手动空调数据流通道号是多少 浏览:303
手机qq令牌 浏览:737
cg原画上色教程 浏览:993
婚介服务中心app怎么做 浏览:43
日本苹果66g多少钱 浏览:93
个性的文件夹名称 浏览:697
怎么设置文件打开密码 浏览:811
手机版qq客服代码怎么用 浏览:24
fme可以打开哪些文件 浏览:339
好看的qq密码 浏览:293
安卓唯一标识有哪些 浏览:243
win10ime 浏览:271

友情链接