Java编程基础：4.9 注释javadoc

9 注释javadoc

可注释的内容：

1. 包

   2. 共有类和接口
   3. 公有的 和 受保护的 构造器和方法
   4. 公有的 和 受保护的 域

  /**
	* 其他描述
    * @author	作者名
    * @version 版本号
    * @since 指明需要最早使用的jdk版本
    * @param  参数说明
    * @param  一个方法所有@param放在一起
    * @return 标记当前方法的返回部分
    * @throws  添加一个注释，用于表示这个方法可能抛出异常
    */

使用CMD生成专业文档

	1. 首先进入源文件所在文件夹，打开CMD，输入下面第一行的代码

javadoc -encoding UTF-8 -charset UTF-8 learn491.java 	
// -encoding UTF-8	是utf-8编码读取文件
// -charset UTF-8	是生成的javadoc的编码  防止中文出现乱码
// 会在源文件所在的文件目录下生成javaDoc文档

使用IDEA生成专业文档

1. Tools — Generate JavaDoc

   

2. 第一个红框是要选择输出文档的文件：整个project，指定文件，自定义

   第二个红框是javaDoc输出的目录

   第三个红框是编码参数，不加中文会乱码（不加会以GBK形式读取和生成javaDoc编码）

打开生成的专业文档

打开生成文件中的index.html文件