⑴ eclipse怎么生成javadoc
方法/步骤
1
注意:本经验使用的eclipse版本为
Eclipse Java EE IDE for Web Developers.
Version: Luna Service Release 1 (4.4.1)
Build id: 20140925-1800
打开java代码,编写JavaDoc 注释,只有按照java的规范编写注释,才能很好的生成API文档,javadoc注释与普通注释的区别为多一个*(星号)。普通代码注释为/*XXX*/,而javadoc的注释为/**XXX*/
javadoc注释要尽量写的详细,这样别人在没有源码的情况下才知道如何使用您的代码。
点击eclipse的【Project】菜单,选择【Generate JavaDoc】选项。
(1)选择您要生成JavaDoc的工程
(2)选择哪些级别的内容生成JavaDoc,默认为public,如果选择private则会全部内容都生成。
(3)选择doc的生成位置,默认为工程目录下,建议不要修改。
(5)点击【Next】按钮
(1)勾选Document Title,然后填写文档标题。
(2)点击【Next】按钮
(1)选择使用的jdk版本
(2)点击【Finish】按钮
可以看到控制台输出生成javadoc的信息。
项目下生成一个【doc】的目录,里面存放着javadoc文档。
打开doc目录,用浏览器打开index.html
可以看到一个完整的API文档、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对话框开始是一样的。 呵呵,方便的生成了有用的文档。真是个好用的功能啊。 所以,平时写东西的时候要注意写注释啊
⑶ 如何解决eclipse与javadoc
1、在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步。在Javadoc Generation对话框中有两个地方要注意的:javadoc command:应该选择jdk的bin/javadoc.exedestination:为生成文档的保存路...
⑷ Eclipse中的这个@javadoc窗口是什么作用
可以看到当前代码生成的javadoc怎么样。打开它。然后在代码里随便选一个方法,就会把该方法的javadoc显示出来,当然,如果你没有写过该方法的javadoc,你什么也不会得到。
⑸ 如何在eclipse 中设置自动添加Javadoc注释
在eclipse 中设置自动添加来Javadoc注释
1.首先自打开eclipse,然后随意打开一个java类文件,最好找一个没有注释的类,方便实践一下;
2. 在已经打开的eclipse中,点击顶部工具栏中的window目录下的perference按钮,进入perference窗体;
3. 在perference窗体的左边栏中,输入Code Templates ,按回车键回车,就能快速定位到Code Templates;
4. 在Code Template 中找到comment目录,该目录下就是有关注释的相关代码风格设置,这里有各种类型,字段,类型,构造方法以及继承的方法,这里面已经是系统默认的注释,你可以点击edit按钮自行定义,现在重要的是点击下面的勾选按钮进行勾选,然后保存设置;
5. 在eclipse代码编辑区域,选中一方法,该方法实现了某接口定义的方法,像图中所示选中它,按快捷键Shift+Alt+J;
6.经过上面的快捷键操作,就能看到,Javadoc注释的代码已经自动添加到编辑方法体上面,方便以后开发的阅读,提高效率!
⑹ 如何使用eclipse生成javadoc帮助文档
右击你的项目--》Export--》java--》javadoc--》next出现如下页面
点击上图的Configure按钮,进入到安装jdk的目录,选择bin目录先的javadoc.exe文件。点击next到下一步,再点击next到达
在文本框中输入如图所示的“-encoding UTF-8 -charset UTF-8”点击finish。完成操作。(如果你项目的编码是utf-8的话。默认应该是GBK。
注意事项,安卓需要将对应的android.jar包导入到项目中才能够成功的生成javadoc
⑺ eclipse怎样生成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对话框开始是一样的。
⑻ 如何在eclipse添加javadoc
假设源代码在 C:\src 目录下,其中 com.liigo 是主包,其下可能有数十个子包,数百(千)个Java文件。目录结构大约是这样的:
- C:\
| src\
| com\
| liigo\
| ***
怎么才能以最简捷的方式生成所有的API文档呢?
c:\>
c:\>cd src
c:\src>javadoc -d doc -subpackages com.liigo
这样就搞定了,最终生成的API文档位于 c:\src\doc 目录(该目录是由javadoc.exe自动生成的)。
上面的用法利用了“当前目录”和“相对路径”,当然也可以用绝对路径:
...>javadoc -d c:\doc -sourcepath c:\src -subpackages com.liigo
最终生成的API文档位于 c:\doc 目录(该目录同样是由javadoc.exe自动生成的)。
总结一下:
我们只用到了javadoc的三个参数: -d,-subpackages,-sourcepath,其中:
参数 说明
-d 指定API文档的输出目录,默认是当前目录。建议总是指定该参数。
-sourcepath 指定源代码路径,默认是当前目录。 此参数通常是必须的。
-subpackages 以递归的方式处理各子包。关键参数!如果不使用本参数,每次只能处理一个子包(或需手工列出所有子包)。
注:以上示例要求 javadoc.exe 所在路径位于系统环境变量“PATH”中。
补充一点:
使用参数 -author 可以将作者信息(@author ***)导出到最终生成的API文档中, -version 可以生成版本信息。如果是自己写的一个包,千万不要忘了用 -author 哦:)
最终完整的命令行是:
...>javadoc -d c:\doc -sourcepath c:\src -subpackages com.liigo -author -version
⑼ eclipse怎么加载javadoc
方法如下: 1. Window->Pereferences...打开参数选择对话框,展开Java节点,单击“InstalledJREs",此时右边窗口会显示已经加载的jre。 2. 选中要设置的jre版本,单击"Edit",弹出JRE编辑窗口 3. 添加javadoc:将JREsystem libraries下的所有包选...