Java中的命名规范

Posted 2023-04-03 老师好我是王同学381

目录

命名规则

Java的命名一共有三种形式:

项目命名:

包命名:

类命名:

方法:

变量&常量命名:

变量命名:

常量命名:

代码注解:

注解的原则:

类注解:

属性注解:

方法注解:

构造方法注解:

总结:

---

命名规则

1.名称只能由字母,数字,下划线,$组成

2.不能以数字开头

3.名称中不能出现Java的关键字

4.内容坚决不能出现拼音和中文名称

5.命名应该做到见明知义

Java的命名一共有三种形式:

首字母大写Feature,首字母小写getByld,大写下划线UPPERCAMELUNSER_SCORE

项目命名:

全部使用小写,多个单词使用中划线"-"分割开.spring-cloud

包命名:

全部使用小写,使用小写点"."分隔开com.example.weather

包名统一使用单数形式

类命名:

类名使用大驼峰的命名形式,每个单词的首字母都大写HashMap

类名通常是名词或者名词短语,接口可以使用形容词或者形容词短语,来表示接口的要实现的某种功能或者能力.

对于测试类则要使用该测试的类开头+Test.HashMapTest

方法:

方法名使用小驼峰的命名形式,开头的首字母小写,往后的每个单词的首字母的单词都要大写userName

方法名一般使用动词或者动词短语,与参数或者参数名共同形成动宾短语,即动词+名词.

一个好的函数名,可以通过名字直接知悉函数实现了什么功能.

变量&常量命名:

变量命名:

变量名使用小驼峰的命名形式,开头的首字母小写,往后的每个单词的首字母的单词都要大写.userName

变量命名应该简短且富于描述,易于记忆且能指出用途.尽量避免单个字符的变量名.

常量命名:

常量命名一般使用的都是大写加下划线"_"CONSTANT_CASE

常量是在作用域中保持不变的值,一般使用final进行修饰.

一般分为三种:全局常量(public static final),类内常量(private static final),局部常量(方法内,或者参数中的常量)(局部常量比较特殊,通常使用小驼峰命名的方法即可)

代码注解:

注解的原则:

1.注解一定要写,不仅要记录代码大逻辑,还要说清楚修改的逻辑

2.能够表达清楚的代码不需要注解,注解的滥用会增加额外的负担

3.注解应该随着代码的改变而改变

类注解:

这是一个用来做什么的类,有什么功能,用到了什么

属性注解:

这是什么

/**密码*/ 
private String password;

方法注解:

对方法中的返回值和每个参数都要进行说明

/**
 *
 * 方法的详细说明,能干什么,怎么实现的,注意事项
 *
 * @***    参数的说明
 * @***    返回结结果的说明
 * @***    异常类型
 *
*/

构造方法注解:

/**
 *
 * 构造函数的详细说明
 *
 * @***    参数的说明
 * @***    异常类型
 *
*/

总结:

学号英语很重要,优秀的词汇量对代码的解释和解读都有着很大的提升.

Java中的名称命名规范：

Java中的名称命名规范：（不遵守，也不会出现编译的错误）

• 包名：多单词组成时所有字母都小写：xxxyyyzzz
• 类名、接口名：多单词组成时，所有单词的首字母大写：XxxYyyZzz
• 变量名、方法名：多单词组成时，第一个单词首字母小写，第二个单词开始每个单词首字母大写：xxxYyyZzz
• 常量名：所有字母都大写。多单词时每个单词用下划线连接：XXX_YYY_ZZZ