【Java】注释，关键字，标识符

注释

注释，是用来对代码进行一些解释说明用的，合理的注释可以极大的提高代码的可读性。虽然注释其不参与编译，但是对于程序员来说非常重要

注释的类型

// 单行注释

/*
多行注释
*/

/**
文档注释
*/

其中，文档注释有一些特殊的作用，那么我们在文章后半再做说明

使用注释的时候应该注意以下几点：

1. 多行注释不能嵌套使用
2. 注释长度不宜过长或过短，要在尽可能表达清晰的情况下缩短注释的篇幅
3. 注释应该随着代码的更新而更新

文档注释

在JDK中，有一个工具javadoc，它可以用来配合我们的文档注释，生成一个程序说明文档，方便别人更加容易看懂或者使用我们的代码

那么我们要怎么写文档注释呢？以下面这个简单的代码为例

/**
 *  这个类是入门第一个程序练习，用于打印一个Hello World
 *  @version v1.0.0
 *  @author zhangsan
 *
 */
public class Hello {
    /**
     * main方法是程序的入口函数，其中写法是固定的
     * @param args 这是一个参数
     */
    public static void main(String[] args) {
        System.out.println("Hello World");
    }

    /**
     * 这个方法用于演示文档注释
     * @return 返回值是0
     */
    public int test(){
        return 0;
    }
}

其中类似于@version，@author，@param，@return这样的东西被称作Javadoc标签

Javadoc在生成说明文档的时候会去根据这些标签生成固定格式来说明内容

我们写文档注释的时候，一定要把说明的信息放在你要说明的代码的前面

---

那么假如我们写好了文档注释，那么要怎么用Javadoc去生成说明文档呢？

首先我们前往工程所在的地址，然后在这个位置打开cmd，然后我们可以用javadoc + java文件文件名的方式来生成一个说明文档

以我们上面那个项目为例子，文件名为Hello.java，那么就输入下面的语句

javadoc Hello.java

但是一般这个时候就会有问题发生

原因是cmd的编码方式和我们写代码用的编码方式不一样，那么我们就要强制让cmd和我们的代码使用同一种编码方式

假设我们的代码编码方式为UTF-8，那么我们就在我们刚刚的语句的中间加上-encoding UTF-8 -charset UTF-8

javadoc -encoding UTF-8 -charset UTF-8 Hello.java

其中-encoding UTF-8 表示源代码文件采用UTF-8编码格式，-charset UTF-8表示文档注释文件采用UTF-8编码格式

此时回到我们的项目文件夹会发现生成了一堆HTML文件，其中index.html就是我们需要的

但是仔细看会发现，我们写在里面的@author和@version没有显示

实际上，这两个Javadoc标签在我们生成文档的时候，是需要额外加入语句声明的，如下

javadoc -author -version -encoding UTF-8 Hello.java

那么输入上面的命令行语句后，我们就可以看见作者信息和版本信息了

那可能有人说，每次我要生成一个说明文档还这么麻烦？而且我要是没有装环境变量怎么办？

没关系，我们的强大的IDEA总会有解决的方法，下面就简单介绍一下如何用IDEA生成说明文档

---

然后就可以方便的生成一个说明文档了

总结

关于文档注释的使用，这里也只是初步的简单说明，实际上文档注释还有很多常用的Javadoc标签可以使用，例如：

• @throws：用于描述方法可能抛出的异常类型和说明。
• @see：用于描述引用其他类、方法或变量的链接。
• @deprecated：用于标记已过时的方法或类。

这些需要我们在学习深入中慢慢了解，因就不再过多阐述了

关键字

关键字是Java定义好的一些有特殊含义的标识符或者保留字

Java中的一些常见关键字如下

abstract	assert	boolean	break	byte
case	catch	char	class	const
continue	default	do	double	else
enum	extends	final	finally	float
for	goto	if	implements	import
instanceof	int	interface	long	native
new	package	private	protected	public
return	strictfp	short	static	super
switch	synchronized	this	throw	throws
transient	try	void	volatile	while

随便看看，并不用记

标识符

标识符，说的简单易懂一点就是名字，类似于类名、方法名、变量名这样的都是标识符

标识符的书写有一些硬性的规则，例如：

1. 标识符中可以包含：字母、数字以及下划线和 $符号等
2. 标识符不能以数字开头，也不能是关键字，且严格区分大小写

那么下面是一些软性规定，但是涉及到代码的规范性书写，推荐遵守

1. 类名：每个单词的首字母大写(大驼峰)，例如：HelloWorld
2. 方法名和变量名：首字母小写，后面每个单词的首字母大写(小驼峰)，例如：helloWorld
3. 标识符要尽可能的表示它的用途，并且尽量不要用拼音