javadoc（如何使用javadoc）

本文目录

• 如何使用javadoc
• Java--cmd--javadoc 就出现这个错误,未指定软件包或类，求解
• 如何使用javadoc命令生成api文档，文档注释
• JDK JavaDoc有什么用
• java→cmd下输入javadoc命令，报错未指定程序包或类，怎么改啊，最好可以远程帮助qq191474639
• 为什么使用netbeans编写程序找不到javadoc
• openjdk javadoc在哪
• 找不到javadoc是什么意思
• 如何自动生成javadoc及添加自定义标签
• 计算机二级JAVA技巧:javadoc注释

如何使用javadoc

package com.frank.chapter1;

// object.Documentation1.java
// TIJ4 Chapter Object, Exercise 13 - 1
/* Run Documentation1.java, Documentation2.java and Documentation3.java
* through Javadoc. Verify the resulting documentation with your Web browser.
*/

/** A class comment */
public class Documentation1 {
/** A field comment */
public int i;
/** A method comment */
public void f() {
}
}
如上一段代码，使用了javadoc的注释形式，注释以/** 开始, 以*/ 结尾，注释写在要说明部分的前面。
如何生成javadoc呢？ 很简单，在eclipse中点击导航栏中的 project-》Generate javadoc 跳出如下界面，然后勾选需要生成文档的包以及生成文档的位置就OK啦！~
更详细的说明见转载
***隐藏网址***
通常我们写java程序可能很少会写注释的，但是在公司里真正开发项目的时候。通常都会有严格的文档要求，我这里谈到的不是设计或者测试文档，而是javadoc。我一直认为javadoc察看起来比MSDN要方便，写起来同样不复杂。
javadoc是j2sdk里面一个非常重要的工具，如果你按照规范在java的源代码里面写好注释的话，那么它就可以生成相应的文
档。开发者察看起来会非常方便。很多IDE都可以直接生成javadoc的，这里介绍如何写javadoc以及如何在eclipse下生成
javadoc。
javadoc通常从package、公开类或者接口、公开或者受保护的字段、公开或者受保护的方法提取信息。每条注释应该是以/**开始以*/结尾。例如
/**
*
* @param id the coreID of the person
* @param userName the name of the person
* you should use the constructor to create a person object
*/
public SecondClass(int id,String userName)
{
this.id = id;
this.userName = userName;
}
注释应该写在要说明部分的前面，如上所示。并且在其中可以包括html的标记，如果上面没有标记
的话，那么you should usr the ......将会在javadoc里面紧跟@param userName....，这样不是我们希望的。一般注释可以分为类注释、方法注释、字段注释等。下面分别作简单的介绍
类注释
类注释应该在import语句的后面在类声明的前面，比如
package com.north.java;
/**
* @author ming
*
* this interface is to define a method print()
* you should implements this interface is you want to print the username
* @see com.north.ming.MainClass#main(String)
*/
public interface DoSomething
{
/**
* @param name which will be printed
* @return nothing will be returned
*
*/
public void print(String name);
}
其中@author 和@see都是常用的注释 第一个表示作者，第二个表示参考的连接。
2.方法注释
方法注释要紧靠方法的前面，你可以在其中使用@param @return @throws等标签。例如
/**
*
* @param i
* @return true if ..... else false
* @throws IOException when reading the file ,if something wrong happened
* then the method will throws a IOException
*/
public boolean doMethod(int i) throws IOException
{
return true;
}
3.字段注释
只有public的字段才需要注释，通常是static德，例如
/**
* the static filed hello
*/
public static int hello = 1;
在eclipse中我们新建java
project然后编写几个接口和类以后就可以用javadoc生成文档了，从菜单project选择generate
javadoc，会出现一个向导，你按照他的提示一步一步的设定要求，最好他会问你是不是声称一个javadoc.xml，如果选择生成的话，他会在
doc下产生一个javadoc.xml，以后更新文档的时候你可以直接用ant运行javadoc.xml。选择完成后你可以发现在project里面
出现了一个目录doc里面就是你的javadoc,想写出好的javadoc一个非常好的办法就是多参考java的api
doc。养成一个好的编程习惯非常重要，何况这并不难。

Java--cmd--javadoc 就出现这个错误,未指定软件包或类，求解

如果是Tomcat闪退问题可以试一下以下方法：

win10系统：

重点：1。在JAVA_HOME变量里添加jdk\bin地址和jre\bin地址

2.创建Tomcat的环境变量：TOMCAT_HOME=E:\tomcat-6.0.35 （解压后的tomcat文件目录）

3.在Path里添加%JAVA_HOME%和%TOMCAT%（注意，在Home里包含了bin文件夹，此处不用再添加\bin）

然后：

1.在已解压的tomcat的bin文件夹下找到startup.bat，右击-》。在文件头加入下面两行：

SET JAVA_HOME=D:\Java\jdk1.6.0_10 （java jdk目录）（你当前的jdk版本）

SET TOMCAT_HOME=E:\tomcat-6.0.35 （解压后的tomcat文件目录）

2.同样的。在已解压的tomcat的bin文件夹下找到shutdown.bat，右击-》。在文件头加入下面两行：

SET JAVA_HOME=D:\Java\jdk1.6.0_10 （java jdk目录）

SET TOMCAT_HOME=E:\tomcat-6.0.35 （解压后的tomcat文件目录）

貌似应该是环境变量的问题，本人亲测有效

引用链接：网页链接

如何使用javadoc命令生成api文档，文档注释

使用javadoc命令生成api文档：

1. 创建java源文件包。java文件都是存放在一个package包中，这样方便对java文件进行操作和区分，首先在磁盘上创建文件夹一样的方式创建package包。
   

2. 创建java源文件。在包下，创建与文件名相同的java源文件，输入一些文档注释，这些文档注释用于自动的api文件进行说明使用。

3. 进入java源文件目录。通过cd等windows命令进入java源文件包所在的磁盘位置。

4. 查看javadoc命令使用说明。如果是第一次使用javadoc命令，可以通过javadoc -help命令查看javadoc使用说明。

5. 开始创建api文件。使用命令输入javadoc -d javaapi -header 测试的API -doctitle 这是我的第一个文档注释 -version -author javadoc/Hello.java 进行文档生成。-d:文件存储位置; -head:文件头部名称; -version:显示版本; -author:显示作者; javadoc/Hello.java 处理的文件包以及java源文件。

6. 查看生成的api文件。创建成功之后，就会自动创建指定的文件夹下生成api文件。打开index.html就是api文件的入口。
   

JDK JavaDoc有什么用

JDK是一个工具包，里面包括很多高级Java开发时需要用到程序库和调试工具，比如虚拟机监控工具、内存工具、编码工具、打包工具、文档工具等等。其中的javadoc就是文档工具，用来自动根据代码中的带有特定格式的注释来生成HTML格式的文档。典型的一个例子就是Java官网的API解释。这些文档就是根据Java源代码中的注释自动生成的。

java→cmd下输入javadoc命令，报错未指定程序包或类，怎么改啊，最好可以远程帮助qq191474639

环境变量配置了吗？设到JDK的BIN目录。javadoc.exe在BIN目录下面，没有设环境变量就不能调用javadoc命令。

为什么使用netbeans编写程序找不到javadoc

应该是环境变量没有配置正确，开发工具调用时找不到javadoc工具导致，重新配之下环境变量吧

openjdk javadoc在哪

***隐藏网址***
不过要注意的是OpenJDK（也传递到Oracle JDK）的javadoc是在javac的基础上实现的。而javac的源码在隔壁的另一个目录里：
jdk8u/jdk8u/langtools: 2baeb96fa198 /src/share/classes/com/sun/tools/javac/
其中javac的parser在com.sun.tools.javac.parser包下，而AST类型声明在com.sun.tools.javac.tree包下。
javadoc要先让javac把源码的语法分析（parse）做好，得到里面的javadoc注释之后，再由javadoc自己的逻辑去分析注释里的内容并且生成HTML文档文件。

找不到javadoc是什么意思

应该是你开发的工具下，你的工具不能找到你所用JAR的API，要你人工设定javadoc的路径。

如何自动生成javadoc及添加自定义标签

右键工程 点击Export 如图 选择javadoc

点击next

如图 设置JDK里面的javadoc.exe的地址 点击finish 到此就可简单生成一个javadoc 前提是你的类里面有类似下图的注释

遇到的问题

1.在使用中文注释的时候 遇到编码 GBK 的不可映射字符这个问题

解决方法 在上面的最后一步中 不要点击finish  一路next到最后一个页面

如图输入-encoding UTF-8 - charset UTF-8即可

2.自定义标签

eclipse自带有几个标签 如@author @version等 如何在doc文档中自动生成自定义的标签呢

只需在上面的对话框中 再添加一句 -tag CreateBy:a:"CreateBy"  其中 CreateBy 为你自定义的标签

计算机二级JAVA技巧:javadoc注释

对于软件工程来说代码的编写并不是重要的事情。文档编写的重要性不亚于程序代码本身。如果代码与文档是分离的，那么在每次修改代码时，都需要修改相应的文档就会是一件相当麻烦的事情。所以我们通过javadoc将代码同文档“连接”起来。
　　Javadoc是什么？
　　javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形式程序的开发文档了。
　　Javadoc输出的是一些HTML文件，我们可以通过WEB浏览器来查看它。
　　Javadoc的语法：
　　所有Javadoc都只能源于/**开始和*/结束。使用javadoc有二种方式，一种是嵌入HTML另一种是使用文档标签。所谓文档标签就是一些以 “@”开头的命令，且“@”要置于注释行的最前面。而“行内文档标签”则可以出现在Javadoc注释中的任何地方，它们也是以“@”字符开头，但要括在共括号内。
　　Javadoc只能为public或者protected成员进行文档注释。private和包内访问的成员的注释会被忽略掉。这样做是有道理的，因为只有public和protected成员才能在文件之外被使用，这也体现了封装性的优点。
　　嵌入HTML:
　　Javadoc将HTML代码嵌入到所生成的HTML文件中。这样能充分利用HTML的功能。比如：
　　/**
　　*
　　*this is my test program;
　　*
　　*/
　　但一般我们不要在HTML里使用标题，如