java注释

书写注释是一个好习惯，注意规范

• 单行注释 //
• 多行注释 /**/
• 文档注释 /***/

javadoc命令是用来生成自己的API文档，
1、java文件cmd窗口下

javadoc 参数 文件.java
javadoc -encoding UTF-8 -charset UTF-8 Doc.java

2、idea生成javaDoc文档

• 英译版：tools--->Generate JavaDoc

英译版生成javaDoc

• 汉翻版 ：工具 -------> 生成javaDoc

汉翻版生成javaDoc

参数信息
- @author 作者名
- @version 版本号
- @since 指明需要最早使用的jdk版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
/**
* 作用在方法和类上
* @author 作者名
*/  

有趣的代码注释:resource文件下banner.txt

关键字

常见关键字

java所有的组成成分都需要名字。类名，变量名和方法名都被称为标识符。

狂神study