JAVA编码规范

JAVA编码规范

标识符和关键字

标识符

Java语言中，对于变量，常量，函数，语句块也有名字，我们统统称之为Java标识符.

标识符是用来给类、对象、方法、变量、接口和自定义数据类型命名的。

标识符命名规范

①由数字，字母和下划线（_），**美元符号（$）或人民币符号（￥）**组成。

②不能使用数字开头

③不能使用Java中的关键字作为标识符

④严格区分大小写

标识符命名约定

①类和接口名。每个单词的首字母大写。例如，MyClass，HelloWorld，Time等。大驼峰式命名

②方法名。第一个单词的首字母小写，其余单词的首字母大写。尽量少用下划线。例如，myName，setTime等。这种命名方法叫做小驼峰式命名

③常量名。基本数据类型的常量名使用全部大写字母，**单词与单词之间用下划线分隔。**例如，SIZE_NAME。

④变量名。可大小写混写，第一个单词首字母小写，其余单词的首字母大写。不用下划线，少用美元符号。给变量命名是尽量做到见名知义。小驼峰式命名

关键字

Java关键字是对Java编译器有特殊含义的字符串，是编译器和程序员的一个约定，程序员利用关键字来告诉编译器其声明的变量类型、类、方法特性等信息

关键字及含义

关键字	含义
abstract	表明类或者成员方法具有抽象属性
assert	断言，用来进行程序调试
boolean	基本数据类型之一，声明布尔类型的关键字
break	提前跳出一个块
byte	基本数据类型之一，字节类型
case	用在switch语句之中，表示其中的一个分支
catch	用在异常处理中，用来捕捉异常
char	基本数据类型之一，字符类型
class	声明一个类
const	保留关键字，没有具体含义
continue	回到一个块的开始处
default	默认，例如，用在switch语句中，表明一个默认的分支。Java8 中也作用于声明接口函数的默认实现
do	用在do-while循环结构中
double	基本数据类型之一，双精度浮点数类型
else	用在条件语句中，表明当条件不成立时的分支
enum	枚举
extends	表明一个类型是另一个类型的子类型。对于类，可以是另一个类或者抽象类；对于接口，可以是另一个接口
final	用来说明最终属性，表明一个类不能派生出子类，或者成员方法不能被覆盖，或者成员域的值不能被改变，用来定义常量
finally	用于处理异常情况，用来声明一个基本肯定会被执行到的语句块
float	基本数据类型之一，单精度浮点数类型
for	一种循环结构的引导词
goto	保留关键字，没有具体含义
if	条件语句的引导词
implements	表明一个类实现了给定的接口
import	表明要访问指定的类或包
instanceof	用来测试一个对象是否是指定类型的实例对象
int	基本数据类型之一，整数类型
interface	接口
long	基本数据类型之一，长整数类型
native	用来声明一个方法是由与计算机相关的语言（如C/C++/FORTRAN语言）实现的
new	用来创建新实例对象
package	包
private	一种访问控制方式：私用模式
protected	一种访问控制方式：保护模式
public	一种访问控制方式：共用模式
return	从成员方法中返回数据
short	基本数据类型之一,短整数类型
static	表明具有静态属性
strictfp	用来声明FP_strict（单精度或双精度浮点数）表达式遵循IEEE 754
super	表明当前对象的父类型的引用或者父类型的构造方法
switch	分支语句结构的引导词
synchronized	表明一段代码需要同步执行
this	指向当前实例对象的引用
throw	抛出一个异常
throws	声明在当前定义的成员方法中所有需要抛出的异常
transient	声明不用序列化的成员域
try	尝试一个可能抛出异常的程序块
void	声明当前成员方法没有返回值
volatile	表明两个或者多个变量必须同步地发生变化
while	用在循环结构中

关键字的分组

①用于数据类型。
　　用于数据类型的关键字有 boolean、byte、char、 double、 false、float、int、long、new、short、true、void、instanceof。

②用于语句。
　　用于语句的关键字有break、case、 catch、 continue、 default 、do、 else、 for、 if、return、switch、try、 while、 finally、 throw、this、 super。

③用于修饰
　　用于修饰的关键字有 abstract、final、native、private、 protected、public、static、synchronized、transient、 volatile。

④用于方法、类、接口、包和异常。
　　用于方法、类、接口、包和异常的关键字有 class、 extends、 implements、interface、 package、import、throws。

⑤Java还有3个保留字:
true、false、null，它们不是关键字，包含Java定义的值。和关键字一样,它们也不可以作为标识符使用。

注释

JAVA注释的本质

编译器在进行程序编译的时候如果发现有注释的内容将不对此部分进行编译处理

书写注释是一个非常好的习惯，可以提高代码的可读性

①单行注释

单行注释的符号为：//

例如：

public class HelloWorld
{
    public static void main(String[] args)
    {
        //输出HelloWorld
        System.out.println("HelloWorld!")
    }
}

②多行注释

多行注释的符号为：/* … */

例如：

public class HelloWorld
{
    /*
     *这是main方法，入口函数
     *@param args
     */
    public static void main(String[] args)
    {
        System.out.println("HelloWorld!")
    }
}

③文档注释

文档注释的符号为：/** … */

可以使用javadoc生成注释文档,注释文档为HTML文件，文件名为：java源文件名.html

例如：

/**
 *这是HelloWorld类
 *@autor 作者
 *@
 */
public class HelloWorld
{
    public static void main(String[] args)
    {
        System.out.println("HelloWorld!")
    }
}

将源代码保存之后,WIN+R打开命令行模式输入：

javadoc -d <目标路径> -author -version <文件路径\文件名.java>

javadoc:生成注释文档的命令

-d:表示目标路径，在-d后写要生成文档注释的目标路径

-author：可选项，author表示作者

-version:可选项，version表示版本

如下图：

打开HelloWorld.html文件后：
如下图：