标示符、关键字、变量
注释
-
API文档 : 就是java注释的html文档。
-
java源码代码中的注释,不会出现在字节码文件中。
(源代码中被注释掉的部分,不会对代码的编译、运行产生任何影响。)
-
注释的作用 : 代码说明 + 代码调试。
-
~ = /home/briup
-
单行注释 // : 某行代码 某个变量、属性说明
多行注释 /* */ 【可以每行前面1个 * 】
文档注释 /** */
- 单行注释可以嵌套
- 多行注释不能嵌套多行注释,编译报错。
javadoc
-
常用的javadoc标记有:
@author:作者
@version:版本
@deprecated:不推荐使用的方法、过时的方法。
@param:方法的参数类型。
@return:方法的返回类型。
@see:用于指定参考的内容。
@exception:抛出的异常。
@throws:抛出的异常,和exception同义 -
使用javadoc命令,生成api说明文档,并将生成的文档存放在API目录中
-
javadoc -d api -author -version -encoding UTF-8 src/Comment03.java
-
如果要生成所有类的doc文档,可以执行以下命令:这样可以把src下面com包下面所有的子包里面存放的java文件全都查找到并生成对应的doc文档
-
javadoc -d api -sourcepath src -subpackages com -author -version
-sourcepath 指定源代码存放的位置
-subpackages 指定要递归查找的包的名字
-
编码和解码
-
乱码 :编码和解码中没有使用同一套标准。
- javadoc -charset : 通过html告诉浏览器,以utf-8解析
- *.java : 生成所有的.java文件对应的api文档
- 生成整个项目的api文档: 考虑源文件在不同目录下 ,源文件相互关联。
-
Windows中,命令窗口默认使用编码是GBK