IntelliJIDEA中如何使用JavaDoc

　　IntelliJ IDEA 12.1.6，自己提供了很好的 JavaDoc 生成功能，以及标准 JavaDoc 注释转换功能，其实质是在代码编写过程当中，按照标准 JavaDoc 的注释要求，为须要暴露给使用者的类、方法以及其余成员编写注释。而后使用 IDEA 的功能自动调用 javadoc.exe（JDK 自带的工具）根据源代码中的注释内容自动生成 JavaDoc 文档（超文本格式）。这里有几点却是要特别注意一下：html

1. IDEA 的 JavaDoc 生成功能在菜单 Tools->Generate JavaDoc 项里面。java

   • 

      

2. 点击上述菜单项后，会出现生成 JavaDoc 的对话框，通常的选项都很直观，没必要细说。可是要注意生成 JavaDoc 的源代码对象的选择，通常以模块（Module）为主，必要时能够单独选择必要的 Java 源代码文件，不推荐以 PRoject 为 JavaDoc 生成的源范围。api

3. 里面有一个 Locale 可选填项，表示的是须要生成的 JavaDoc 以何种语言版本展现，根据 javadoc.exe 的帮助说明，这其实对应的就是 javadoc.exe 的 -locale 参数，若是不填，默承认能是英文或者是当前操做系统的语言，既然是国人，建议在此填写 zh_CN，这样生成的 JavaDoc 就是中文版本的，固然指的是 JavaDoc 的框架中各类通用的固定显示区域都是中文的。你本身编写的注释转换的内容仍是根据你注释的内容来。浏览器

4. 还有一个“Other command line arguments:”可选填项，很是重要，是填写直接向 javadoc.exe 传递的参数内容。由于有一些重要的设置，只能经过直接参数形式向 javadoc.exe 传递。这里必需要填写以下参数：oracle

   -encoding UTF-8 -charset UTF-8 -windowtitle "你的文档在浏览器窗口标题栏显示的内容" -link http://docs.Oracle.com/javase/7/docs/api框架

   

    

5. 第一个参数 -encoding UTF-8 表示你的源代码（含有符合 JavaDoc 标准的注释）是基于 UTF-8 编码的，以避免处理过程当中出现中文等非英语字符乱码；第二个参数 -charset UTF-8 表示在处理并生成 JavaDoc 超文本时使用的字符集也是以 UTF-8 为编码，目前全部浏览器都支持 UTF-8，这样最具备通用性，支持中文很是好；第三个参数 -windowtitle 表示生成的 JavaDoc 超文本在浏览器中打开时，浏览器窗口标题栏显示的文字内容；第四个参数 -link 很重要，它表示你生成的 JavaDoc 中涉及到不少对其余外部 Java 类的引用，是使用全限定名称仍是带有超连接的短名称，举个例子，我建立了一个方法 public void func(String arg)，这个方法在生成 JavaDoc 时若是不指定 -link 参数，则 JavaDoc 中对该方法的表述就会自动变为 public void func(java.lang.String arg)，由于 String 这个类对我本身实现的类来说就是外部引用的类，虽然它是 Java 标准库的类。若是指定了 -link http://docs.oracle.com/javase/7/docs/api 参数，则 javadoc.exe 在生成 JavaDoc 时，会使用 String 这样的短名称而非全限定名称 java.lang.String，同时自动为 String 短名称生成一个超连接，指向官方 JavaSE 标准文档 http://docs.oracle.com/javase/7/docs/api 中对 String 类的详细文档地址。-link 实质上是告诉 javadoc.exe 根据提供的外部引用类的 JavaDoc 地址去找一个叫 package-list 的文本文件，在这个文本文件中包含了全部外部引用类的全限定名称，所以生成的新 JavaDoc 没必要使用外部引用类的全限定名，只须要使用短名称，同时能够自动建立指向其外部引用 JavaDoc 中的详细文档超连接。每一个 JavaDoc 都会在根目录下有一个 package-list 文件，包括咱们本身生成的 JavaDoc。工具

　　JavaDoc 生成完毕，便可在其根目录下找到 index.html 文件，打开它就能够看到咱们本身的标准 JavaDoc API 文档啦。编码