❶ java高手:javadoc 在哪个文件夹中,它的作用是什么
在JDK目录下的bin子目录中
Javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形式程序的开发文档了。
JBuilder提供了多项对Javadoc支持的功能,可以通过向导在工程窗格的树中创建Javadoc的节点,通过节点的菜单命名创建工程的Javadoc文档,可以通过诱导的方式录入Javadoc的标签,检验注释是否和源代码相匹配等。
本文,我们将讲解如何在源代码中用Javadoc标签写注释及如何创建Javadoc文档。
虽然软件工程中把详细设计作为软件项目的一个重要的阶段,但在实践中往往没有得到落实。并不是这个阶段不重要,而是实施有很大的困难,因为软件需求是天生的易动症患者,好不容易详细设计出来后,需求已和当初的版本大相径庭,而花费巨大,精雕细琢的详细设计已变成昨日黄花了。
Javadoc注释由Javadoc标签和描述性文本组成,你可以为类、接口添加注释,也可为构造函数、值域、方法等类中的元素添加注释。
可以通过代码模板快速的录入Javadoc注释,你也可以选择通过Javadoc对话框以一种形象化的方式录入Javadoc注释。此外,JBuilder还提供了各种Javadoc的辅助功能,如JavadocInsight诱导录入,冲突报告和更正,特殊的todo标签等。
虽然在Java文件中编写注释后,马上可以切换到内容窗格的Doc视图页代码中对应的Javadoc文档,但在Doc视图页中生成的文档仅是不完整的"范本"。首先,没有导航树,其次没有生成通过@see或@link关联内容的链接。所以你可以把Doc视图页中的Javadoc文档看成是Javadoc最终版本的预览。
本文中我们介绍了Javadoc的标签,讲解了如何在JBuilder编辑Javadoc注释,你应该尽量使用JavadocInsight、ClassInsight和ParameterInsight快速而正确地编写Javadoc注释。此外你应该将常用的注释做成模板,方便快速录入。
JBuilder提供的注释冲突报告和恢复的功能可以使你轻松解决注释冲突的问题,免除了单调的手工调整操作。
JBuilder还允许你自定义Javadoc标签,以满足一些个性化的要求。此外JBuilder自定义的todo标签可以使你随时随地在需要的地方作上标记,不至于遗漏未尽的工作。
❷ 如何在IntelliJ IDEA中生成JavaDoc帮助文档
我们用IntelliJ IDEA编辑好Java项目以后,一般需要生成一个JavaDoc文档供相关人员阅读。那么如何生成JavaDoc文档呢?下面小编给大家演示一下。
1、首先我们需要在桌面上新建一个文件夹用于存放JavaDoc的文件,如下图所示
2、接下来点击IntelliJ IDEA顶部的Tools菜单,选择Generate JavaDoc选项,如下图所示
3、然后在弹出的界面中我们点击Output directory输入框后面的按钮,如下图所示
4、在弹出的选择文件夹界面中选择刚才新建的文件夹,如下图所示
5、接下来在底部的Locale输入框配置语言和编码集,如下图所示,语言用zh_CN,代表中文
6、然后点击确定以后我们就等待IntelliJ IDEA给我们生成JavaDoc文档即可,等到输出栏出现如下图所示的提示代表生成完毕
7、接下来我们打开JavaDoc文件夹,找到index.html文件,点击它,如下图所示
8、最后我们就可以看到如下图所示的JavaDoc文档了,它把项目中所有的类,程序包都给写到文档了,非常的详细
工具/材料
IntelliJ IDEA
❸ Android studio怎么生成javadoc
一、为代码生团此成注释
Android studio 下载javadoc 插件。
选择要生成注释的工程,模块或者Java文件,右键选择如下图的,JavaDocs ->Create JavaDocs for all elements
javadoc:错误-com.sun.tools.doclets.internal.toolkit.util.DocletAbortException:com.sun.tools.javac.code.Symbol$CompletionFailure:找不到java.lang.FunctionalInterface的类文件
❹ Java--cmd--javadoc 就出现这个错误,未指定软件包或类,求解
如果是Tomcat闪退问题可以试一下以下方法:
重点:1。在JAVA_HOME变量里添加jdkin地址和jrein地址
2.创建Tomcat的环境变量:TOMCAT_HOME=E: omcat-6.0.35 (解压后的tomcat文件目录)
3.在Path里添加%JAVA_HOME%和%TOMCAT%(注意,在Home里包含了bin文件夹,此处不用再添加in)
然后:
1.在已解压的tomcat的bin文件夹下找到startup.bat,右击->编辑。在文件头加入下面两行:
SET JAVA_HOME=D:Javajdk1.6.0_10 (java jdk目录)(你当前的jdk版本)
SET TOMCAT_HOME=E: omcat-6.0.35 (解压后的tomcat文件目录)
2.同样的。在已解压的tomcat的bin文件夹下找到shutdown.bat,右击->编辑。在文件头加入下面两行:
SET JAVA_HOME=D:Javajdk1.6.0_10 (java jdk目录)
SET TOMCAT_HOME=E: omcat-6.0.35 (解压后的tomcat文件目录)
貌似应该是环境变量的问题,本人亲测有效
引用链接:网页链接
❺ 将.java生成chm,用easychm可以将图片和txt和html生成chm文件,如何将.java文件也生成jchm文件呢
你需要先导出自己工程的api,到出后在工程里面的doc文件夹就会相关的文件,也包括你想转换的html文件,再用你的easychm转吧,不行的话建议你下载一个hugechm,导出工程:右键工程-->export-->java-->javadoc-->next。第一次导出的话需要你在javadoc command中选择执行行程序,选择jdk安装目录下bin目录下的javadoc.exe文件(比如我的:C:\Program Files\Java\jdk1.7.0_45\bin\javadoc.exe),在use standard doclet处选择导出文件放置的位置,默认就好
,如果用hugechm的话就把导出的doc文件下的index.html放进去,打包就可以了,希望你能帮到你
❻ 如何使用javadoc命令生成api文档,文档注释
代码如下:
[java]view plain
/**
*计算器工具类
*
*@authorGaoHuanjie
*@versionV1.0
*/
publicclassComputerUtil{
/*
*加法运算
*
*@parama加数a
*@paramb加数b
*@return返回两个整数的和
*/
publicstaticintadd(inta,intb){
returna+b;
}
/**
*减法运算
*
*@parama被减数
*@paramb减数
*@return返回两个整数的差
*/
publicstaticintsubtraction(inta,intb){
returna-b;
}
/**
*乘法运算
*
*@parama因数
*@paramb因数
*@return返回两个整数的乘积
*/
(inta,intb){
returna*b;
}
/**
*除法运算
*
*@parama被除数
*@paramb除数
*@return返回两个整数的商
*/
intdivision(inta,intb){
returna/b;
}
/**
*取余运算
*
*@parama被除数
*@paramb除数
*@return返回两个整数的相除后的余数
*/
privateintresial(inta,intb){
returna%b;
}
}
步骤:
①、打开DOS窗口;
②、定位到到该类的源文件所在文件夹;
③、输入命令:javadoc -d c:help -author -version ComputerUtil.java
说明:-d:其后空一格,用来指定生成的帮助文档存放的位置;
-author:用来指定生成的帮助文档必须显示该类的作者,如果没有这一命令则生成的帮助文档将不会显示作者;
-version:用来指定生成的帮助文档必须显示该类的版本,如果没有这一命令则生成的帮助文档将不会显示版本;
④、点击回车键。
结论:
①、Java中多行注释分为文档注释和非文档注释,只有文档注释所注释的内容才会出现在帮助文档中,非文档注释所注释的内容不会出现在帮助文档中(比如add方法,由于该方法的注释是非文档注释,所以注释内容没有生成到帮助文档中,只出现了该方法的一些信息);
②、只有被public和protected修饰的方法添加的文档注释的注释内容才能出现在帮助文档中,所以division方法和resial方法尽管采用了文档注释,但注释内容和方法信息却没有出现在帮助文档中;
❼ intellij idea怎么设置java帮助文档
打开idea我引用的jar包都放在
Project Structure——>Moles——>libs文件夹(双击)
双击jar包所在文件夹,跳出对话框内。
1.如果api对应的javadoc文档放在本容地,则点击红色箭头所指示的按钮,选择javadoc文件夹
2.如果api是网上的,则把网址复制下来,点击蓝色箭头所指示的按钮,在弹出的输入框中写入对应的api网址
完成后,编写java代码的时候有疑问,Ctrl+Q 就会弹出api的介绍了。