javadocutil的简单介绍

今天给各位分享javadocutil的知识，其中也会对进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

• 1、如何使用Javadoc命令导出所有API
• 2、为下面的代码注写详细的javadoc注释
• 3、如何使用javadoc命令生成api文档，文档注释
• 4、editplus中如何设置生成javadoc说明文档的
• 5、Android studio怎么生成javadoc
• 6、eclipse中导出javadoc出错

如何使用Javadoc命令导出所有API

解压 %JAVA_HOME%\src.zip 到sources 目录， 新建 apidocs目录

javadoc -sourcepath sources -d apidocs -public java.lang java.util java.awt javax.swing

想要哪个包，把包名加到后面。

为下面的代码注写详细的javadoc注释

楼主刚开的贴，就删了？？

javadoc是用于开发的开发文档。

一般需要用javadoc的地方有：类名，接口名，定义的方法，构造函数。或者用于属性和getter.setter

不过一般用比较多的是类名，方法。其他的用单选或多选注释即可

/**菜单类*/

public class Menu {

//String name;

//String miMa;

//public void show(){

//System.out.println("请输入用户名："+name);

// System.out.println("请输入密码："+miMa);

//Scanner input=new Scanner(System.in);}

/**显示菜单列表*/

public void showqw(){

System.out.println("\n\n\t\t\t欢迎使用我行我素购物管理系统");

System.out.println("\n\n\t\t\t\t1. 登 录 系 统");

System.out.println("\n\n\t\t\t\t2. 退 出");

System.out.println("\n\n* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * ");

System.out.print("\n请选择，输入数字：");

Scanner input=new Scanner(System.in);

boolean isInputWrong=false;

do{

int choice=input.nextInt();

switch(choice){

case 1:

isInputWrong=false;

showqa();

break;

case 2:

isInputWrong=false;

System.out.println("谢谢使用，程序结束！");

break;

default:

System.out.println("输入错误，请重新输入");

isInputWrong=true;

break;

}

}

while (isInputWrong);

}

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

在工程目录的 src下创建 文件：package.txt .

例如路径：F:\watermusic\MyProject\zwhy\MyUtil\src ，即：在src 下创建，package.txt 。

第二步：

打开doc命令窗口，切换到 F:\watermusic\MyProject\zwhy\MyUtil\src 这个路径下。

输入命令：javadoc -d api @package.txt

回车，这样就可以，生成api 帮助文档了。

不过个人倾向于使用eolinker，其内提供小工具，一键生成代码注释，同时相应文档注释，即可生成相应api文档，较为快捷方便

editplus中如何设置生成javadoc说明文档的

使用eclipse生成文档（javadoc）主要有三种方法：

1. 在项目列表中按右键，选择Export（导出），然后在Export(导出)对话框中选择java下的javadoc，提交到下一步。

在Javadoc Generation对话框中有两个地方要注意的：

javadoc command:应该选择jdk的bin/javadoc.exe

destination:为生成文档的保存路径，可自由选择。

按finish(完成)提交即可开始生成文档。

2. 用菜单选择：File-Export(文件－导出)，

剩下的步骤和第一种方法是一样的。

3. 选中要生成文档的项目，然后用菜单选择，

Project-Generate Javadoc直接进入Javadoc Generation对话框，剩余的步骤就和第一种方法在Javadoc Generation对话框开始是一样的。

用哪种方法都行，但是要注意一下几个问题：

1、eclipse不能生成，报错：

java.lang.IllegalArgumentException at sun.net.

，这是由于设置java环境变量引起的。例如classpath为

.;%JAVA_HOME\lib\dt.jar;%JAVA_HOME%\lib\tool.jar，解决方法就是把classpath删除或是参考官方文档 。

2、生成文档乱码问题。完善api-doc，用eclipse生成javadoc的时候发生“编码 GBK 的不可映射字符 ”其实是字符编码问题。打开eclipse，project - Generate javadoc 一项一项的选你要输出javadoc的项目，最后一步中VM设置行中加入以下代码

复制代码 代码如下:

-encoding utf-8 -charset utf-8

Android studio怎么生成javadoc

一、为代码生成注释

Android studio 下载javadoc 插件。

选择要生成注释的工程，模块或者Java文件，右键选择如下图的，JavaDocs -Create JavaDocs for all elements

二、生成javadoc

选中你要生成javadoc的模块或者工程，点击Android studio 导航栏上Tools -Generate JavaDoc 

1.选择要生成javadoc的范围，是整个工程，还是某个模块；

2.javadoc的生成文件路径，新建一个文件夹；

3.Other command line arguments: 设置

-encoding utf-8 -docencoding utf-8  -charset utf-8 -bootclasspath

“E:\tools\adt-bundle-windows-x86_64-20140624\sdk\platforms\android-22\android.jar”;”C:\Program

Files\Java\jdk1.8.0_45\jre\lib\rt.jar”

注意如果是用的jdk1.8 必须加上”C:\Program Files\Java\jdk1.8.0_45\jre\lib\rt.jar” ，否则会报错：

com.sun.tools.doclets.internal.toolkit.util.DocletAbortException:com.sun.tools.javac.code.Symbol$CompletionFailure:找不到java.lang.FunctionalInterface的类文件

也可以根据需要生成自定义的代码范围。

三、参考

Android Studio Generate JavaDoc(JDK1.8)

Other command line arguments:

-encoding utf-8 -docencoding utf-8  -charset utf-8 -bootclasspath "C:\ProgramData\android-sdk-windows\platforms\android-22\android.jar";"C:\Program Files\Java\jdk1.8.0_45\jre\lib\rt.jar"

notes:

In JDK 1.8 if not have "C:\Program Files\Java\jdk1.8.0_45\jre\lib\rt.jar" will be found

javadoc:错误-com.sun.tools.doclets.internal.toolkit.util.DocletAbortException:com.sun.tools.javac.code.Symbol$CompletionFailure:找不到java.lang.FunctionalInterface的类文件

eclipse中导出javadoc出错

用eclipse导出工程的doc文档，发生编码 GBK 的不可映射字符的错误，这是由于java源代码文件为utf-8编码，源代码中的doc注释喊中文。生成文档时就可能会出现该错误。解决方法：

Export后进入javadoc Generate 时， 点“next”进入第三个对话框时，在"Extra Javadoc options" 文本框里面加上 “-encoding UTF-8 -charset UTF-8”，如图：

2.出现“非法字符：\65279”的解决方法

一般用UE或记事本编辑过的UTF-8的文件头会加入BOM标识，该标识由3个char组成。在UTF－8的标准里该BOM标识是可有可无的,Sun 的javac 在编译带有BOM的UTF-8的格式的文件时会出现“非法字符：\65279”的错误。

用UE等打开该java源文件，另存为无BOM的utf-8格式。

3.如果没报任何错误但是不显示注释 则和1.的解决办法一样

javadocutil的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于、javadocutil的信息别忘了在本站进行查找喔。