Javadoc(文档注释)详解！！！（java中doc注释）

　　本篇文章为你整理了Javadoc(文档注释)详解！！！（java中doc注释）的详细内容，包含有java文档注释是什么 java中doc注释 javadoc注释怎么写 java文档注释怎么注释 Javadoc(文档注释)详解！！！，希望能帮助你了解 Javadoc(文档注释)详解！！！。

　　Javadoc(文档注释)

　　在之前提到过java有三行注释，而关于文档注释，在这里做一个详细的讲解

　　1.java文档注释的作用

　　文档注释只放在类、接口、成员变量、方法之前，以/*开始，/结束，我们可以通过javadoc生产API文档，来对类、成员变量、方法进行说明。API是我们可以直接调用，只需要了解其功能和使用方法，就可以直接拿上去使用。像，java中的Date，math等等。Api在java中就是一个类。

　　2.几种常用的Javadoc标签

　　Javadoc 工具可以识别文档注释中的一些特殊标签，这些标签一般以@开头，后跟一个指定的名字，有的也以{@开头，以}结束。Javadoc 可以识别的标签如下表所示：

　　
3.java生产doc文档

　　我们使用的函数都是之前的前辈们，创建的，那么如何去生产doc文档呢？主要有两种方法

　　使用dos命令生产doc文档

　　Ⅰ.首先我们创建一个Doc.java的文件，也就是类，再给文件添加一些注释，写两个方法

　　代码如下：

public class Doc {

　　 String name;

　　 int n=5;

　　 int m=6;

　　 * @author ling

　　 * @version jdk1.8.0

　　 * @since 1.0

　　 * @param n

　　 * @param m

　　 * @return

　　 public int add(int n, int m) {

　　 int sum = 0;

　　 if (n m){

　　 m--;

　　 }else {

　　 System.out.println(n);

　　 return sum;

　　 public String student(String name) throws Exception{

　　 name="ling";

　　 return name;

　　Ⅱ.查看当前文件所在的目录

　　鼠标右键点击该文件，然后open in Explorer打开文件路径，然后使用dos命令切换到该目录

　　Ⅲ.切换到该目录

　　如果需要切换盘符，就在前面加上/d,否则则不用加

cd /d 该文件所在目录

　　确保该文件目录下有刚才所写的Doc.java文件

　　Ⅳ.执行javadoc命令

javadoc -encoding utf-8 -charset utf-8 Doc.java

　　encoding和后面的charest都是指定编码，把编码类型设置为utf-8，以防出错。

　　Ⅴ.可以看到在该文件夹下生成了好多文件，打开index.html就可以查看生成的doc文档了

　　Ⅵ.查看html文件

　　点击dao

　　利用开发工具生成javadoc文档，我使用的是Intellij Idea生成的doc文档，也可以使用eclipse！

　　1.第一步

　　2.配置生成文件

　　（１）.选择是整个项目还是模块还是单个文件

　　（２）.文档输出路径

　　（３）.Locale 选择地区，这个决定了文档的语言，中文就是zh_CN

　　（４）.传入JavaDoc的参数，一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api

　　3.配置完点击OK即可

　　可以看到文档已生成

　　以上就是Javadoc(文档注释)详解！！！（java中doc注释）的详细内容，想要了解更多 Javadoc(文档注释)详解！！！的内容，请持续关注盛行IT软件开发工作室。

郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。

相关文章阅读