注释（comments）

注释(comments)

注释是不会执行的，只是给人看的

要养成写注释的好习惯

要规范

 

1.单行注释(line comment)

// 注释内容

2.多行注释(block comment)

/*
*注释内容
*/

3.文档注释(JavaDoc) 与多行注释在第一行多了一个*

/**
*@author作者
*@version 版本号
*@since 最早使用jdk版本
*@param 方法参数
*@return 返回值类型
*@discription描述
*@exception 抛出异常
*@throws 抛出异常
*.......
*/

加在类的上面，就是类的注释

加到方法上面，就是方法的注释

javadoc是用来生成自己的API文档

1.cmd 到java文件的地址

2.javadoc -ecording UTF-8 -charset UTF-8 文件名.java

会自动生成自己所创的类的API文档

 

IDEA中自动生成Javadoc的API文档

tools->generate JavaDoc中配置相关参数

 

 

1.所需要整个项目，还是单个项目

2.生成的javadoc的API文档要存到哪

3.文档显示语言，为zh_CN

4.传入JavaDoc的参数，一般写入

-encoding UTF-8 -charset UTF-8 -windowtitle "文档HTML页面标签的标题" -link http://docs.Oracle.com/javase/7/docs/api