Java的标识符、关键字、注释以及javadoc的使用

一、标识符

标识符: 在java程序中有的名字是可以自定义，这些自定义的名字我们就称作为自定义的标识符。

标识符要注意事项：
1. 标识符的组成元素是由 字母（a-zA-Z） 、数字(0-9) 、 下划线(_)、 美元符号($).
2. 标识符不能以数字开头。
3. 标识符是严格区分大小写的。
4. 标识符的长度是没有长度限制的。
5. 标识符的命名一般要有意义（要做到让人见名知意）
6. 关键字、保留字不能用于自定义的标识符。

自定义标识符的规范：
1. 类名和接口名单词的首字母大写，其他单词小写。 比如： RunTime.
2. 变量名与方法名首单词全部小写，其他单词首字母大写，其他小写。 比如： doCook()；
3. 包名全部单词小写。
4. 常量全部单词大写，单词与单词之间使用下划线分隔。 比如： UP_DIRECTION

判断一下那些是 符合的标识符:
12abc_ 不合法 数字不能开头
_12abc 合法
$ab12# 不合法 #号不属于标识符组成元素。
abc@123 不合法 @号不属于标识符组成元素。

二、关键字
关键字：关键字就是在java程序中具备特殊含义的标识符。关键字一般用于描述一个程序的结构或者表示数据类型。

三、注释

注释： 注释就是使用文字对程序的说明，注释是写给程序员看的，编译器会忽略注释的 内容的。

注释的类别：

第一种： 单行注释。 // 注释的内容

第二种： 多行注释。 /* 注释的内容 */
/*
第三种： 文档注释. /** 注释的内容 */
/*
文档注释也是一个多行注释。

注释要注意的细节：
1. 单行注释可以嵌套使用，多行注意是不能嵌套使用的。

注释的作用：
1. 使用文字对程序说明。
2. 调试程序。

多行注释与文档注释的区别：

多行注释的内容不能用于生成一个开发者文档，而文档注释 的内容可以生产一个开发者文档。

使用javadoc开发工具即可生成一个开发者文档。

写注释的规范：一般单行注释是位于代码的右侧，多行注释与文档注释一般是写在类或者方法的上面的。

四、javadoc工具的使用：

javadoc -d 存放文档的路径 java的源文件

使用javadoc工具要注意事项：
1. 如果一个类需要使用javadoc工具生成一个软件的开发者文档，那么该类必须使用public修饰。
2. 文档注释注释的内容一般都是位于类或者方法的上面的。

 

转载于:https://www.cnblogs.com/dongyingit/articles/6674002.html