Java代码的三板斧

---

前言

接上篇：Java程序的运行机制

---

一套成熟且优质的Java代码，必不可少的要有这三项：注释、标识符和关键字

一、Java的注释

平时我们编写代码，在代码量比较少的时候，我们还可以看懂自己写的。但是当项目结构一旦复杂起来，我们就需要用到注释了。

有的大佬跟我讲过这样一个观点：最好的注释就是代码。意思就是最完美的注释就是不要注释，用代码规范的命名和规范的排版就能让大家读懂代码，我觉得，此观点并不适合大部分中国程序员。除了少数，国内大部分程序员英语功底懂的都懂：变量、方法、类、接口、枚举的命名无法做到真正意义上的名如其意。而且有的人写代码又不做优化重构，动辄几十上百行的方法一句代码不写看得人头皮都发麻。

作者原来就接手过一个二手的项目，c++的，28个文件无一句代码，光读代码都花了我一个礼拜。

所以还是老老实实写注释吧，注释并不会被执行，是给我们写代码的人看的。书写注释是一个非常好的习惯，你好我好大家好。

Java的注释有三种：

1. 单行注释：

语法：

// 这是单行注释

IDEA快捷键：Ctrl+/

2. 多行注释

/*
 这是多行注释注释
 这是多行注释注释
 */

IDEA快捷键：Ctrl+Shift+/

3. 文档注释

语法：

/**
 * @Description 这是JavaDoc文档注释
 * @Author 小远
 */

IDEA快捷键：在一个方法或类的开头，输入/**，然后按回车,自动根据参数和返回值生成注释模板，我们在这个模板上面编写即可。

文档注释就是指这种注释内容能够生成API帮助文档，JDK中javadoc命令能够提取这些注释信息并生成HTML文件。文档注释主要对类（或接口）、实例变量、静态变量、实例方法和静态方法等进行注释。

链接：常见的文档注释标签

如果想生成API帮助文档，则可以使用javadoc指令。在命令行中输入javadoc -d apidoc XXX.java指令，-d参数指明要生成文档的目录，apidoc是当前目录下的apidoc目录，如果不存在javadoc，则会创建一个apidoc目录。

如果生成成功，则在当前apidoc目录下生成很多HTML文件，其中的index.html文件是文档的入口。

大公司（如BAT）都会有一套自己的代码编程规范，如阿里的编程规范。所以平时注意代码规范十分有必要！！！

二、标识符

Java所有的组成部分都需要名字：类名、变量名以及方法名都被称为标识符。构成标识符的字母均有一定的规范

1. 区分大小写，Myname和myname是两个不同的标识符
2. 首字符可以是下划线_、美元符$或字母，但不能是数字
3. 除了首字母外其他字符可以是下划线_、美元符$、字母或数字
4. 关键字不能作为标识符

第二点和第三点非常容易混淆：来一些例子帮助记忆：

正确	错误
变量名，clazz，userName，User_Name，$Name，_sys_val	2dogs（数字打头），room#（有#），class（使用关键字）

特别的，注意中文“变量名”，命名的变量是合法的。Java语言中字母采用的是双字节Unicode编码。Unicode叫做统一编码值，它包含了亚洲文字编码，如中文日文韩文等。但是，不推荐使用中文做标识符，对代码来说太不优美。

三、关键字

关键字是类似于标识符的保留字符序列，是由语言本身定义好的，不能做他用。

各处介绍Java关键字的数目不同，有说48个的，有说50个的，有说53个的，也有说更多的。具体的数目其实并不重要，有必要知道吗？ 碰到一个学一个就是了。网上也有总结得很好的文章：比如这篇

之后都会陆续有接触，在此不赘述。

注意：Java中的关键字全部都是小写字母。有两个比较特殊的，一个是goto，另一个是const，这两个字符序列既不能当作标识符使用，也不是关键字（在程序中不能使用）这两个字符序列被称作保留字，也有资料叫他们备用关键字。

---

总结

本文借鉴了部分博主的文章，在此统一致谢，如果您还喜欢，麻烦点个赞。 您的支持就是我更新的动力。

下一篇：Java中的数据类型