(转)创建和查看Javadoc文档

原地址:http://jinnaxu-tju-edu-cn.iteye.com/blog/667177

Javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形式程序的开发文档了。 
javadoc是生成一个java
api文档生成工具,存在于jdk安装目录下的bin目录中。 
说明:生成javadoc
不要求你的java代码是可编译的。唯一要求的是存在.java文件。 
javadoc在eclipse等IDE中使用比较方便,在命令行中使用需要考虑很多参数。可以同多在命令行执行 
javadoc
-help
 
查看参数。 
这里说几个常用的: 
1、如果你在中文系统下使用的源代码编码是UTF-8,你还想输出中文的javadoc,需要指定: 
1)要使用的语言环境:-locale
zh_CN 
2)设置源码编码方式:-encoding
UTF-8 

2、排除一些包,包之间用冒号分隔。 
-exclude
[包路径]:[包路径]:... 

3、生成文档的标题栏标题 
-windowtitle
[标题栏标题文字] 

4、生成文档题目 
-doctitle
[文档题目] 

在eclipse下创建和查看javadoc文档,详细说明: 
1、设置javadoc的命令位置,在eclipse工作台的菜单栏选择【project->Generate
JavaDoc】命令,弹出图1所示对话框。 
在该对话框中,可以在“Java
Command”字段中输入JavaDoc启动命令的绝对路径。 

 
2、单击【Next】,跳到如图2所示的窗口,选择需要生产javadoc文档的元素。 

 
3、单击【Next】,跳到图3所示的对话框,在该对话框中可以在文本区域内设置JavaDoc的参数。 

 
4、单击【finish】,完成对javadoc的创建。 
说明:javadoc文档生成后,在“包自愿管理器”视图中对应的项目目录下,将会多出“doc”和“doc.resources”两个包。 
同时,在“javadoc”视图中也可以查看该元素的信息。 

 
也可通过浏览器查看javadoc,在菜单栏中选择【Natigate->Open
External JavaDoc】命令或是快捷键shift+F2. 

(转)创建和查看Javadoc文档,布布扣,bubuko.com

时间: 2024-10-01 12:59:08

(转)创建和查看Javadoc文档的相关文章

怎么把jdk和jRE的Javadoc文档整合到MyEclipse

有时在写代码时,需要查看javadoc文档,便于编写程序.故如何把Javadoc文档整合到MyEclipse,以便于查看呢? 解决办法: 1.在MyEclipse中菜单栏的“Windows”--->“Preferences(首选项)” 2.左侧导航栏找到Java--->Installed JREs,点击Installed JREs,选中你已有的要添加java API.javadoc的jre或jdk. 3.单击右方的“Edit”,出现Edit JRE对话框,如果你是新建,出现New JRE对话框

MyEclipse查看Struts2源码及Javadoc文档

一.查看Struts2源码 1.Referenced Libraries >struts2-core-2.1.6.jar>右击>properties. 2.Java Source Attachment >External Folder>(选择架包存放目录)/struts-2.1.6/src/core/src/main/java>OK. 3.双击打开struts2-core-2.1.6.jar根目录下的class文件你就可以看到Struts2的源码了. 二.Javadoc

最全Pycharm教程(25)——Pycharm编辑器功能之查看帮助文档

1.准备工作 (1)Pycharm版本号为2.7或者更高 (2)与product documentation的注意事项保持一致 (3)已经创建了一个project而且至少向当中加入了两个脚本文件,详见Getting Started 2.高速查看定义 当你仅仅是想知道相关的声明信息时.最好还是使用Quick definition,而无需跳转到实际的定义位置.比如,将光标定位在一个表达式上.然后在主菜单中选择View→Quick Definition: 你能够在弹出的窗体中看到相关的高速定义信息,然

1.2.3 创建Cocos2D-iPhone的帮助文档

http://book.51cto.com/art/201303/383957.htm <Cocos2D权威指南>第1章开始前的准备工作,本章我们将介绍什么是Cocos2D以及有关Cocos2D的一些重要基础知识,包括如何下载与安装Cocos2D-iPhone的模板.如何安装Cocos2D-iPhone的帮助文档.最后,通过一个有趣的实例介绍如何创建一个最基本的HelloCocos2D项目,并带领读者对这个项目进行深入学习.本节为大家介绍创建Cocos2D-iPhone的帮助文档. AD:WO

类的无参带参方法、变量作用域、JavaDoc文档注释、包

如何定义类的方法 public 返回值类型 方法名(){ //方法的主体 } return:  如果有返回值      跳出方法.返回结果. 如果一个方法有返回值的话,那调用这个方法就会得到这个方法的返回值 方法名一般采用驼峰命名法 Admin admin = new Admin(); 对象是通过类来创建出来的,所以对象的类型是  Admin    也就是说 类是对象的类型 admin.方法名();      //调用无参的构造方法 同一个类中的方法,直接使用方法名调用该方法 不同类的方法,首先

读thinking in java的收获(二) --eclipse生成javadoc文档

最开始学习java语言的时候学过生成javadoc不过当时只是用windows命令行生成.读了这里的javadoc温故而知新发现其实我们做的项目就用到了一些注释,只是没有用eclipse 生成这份文档,通过查阅,最终补全了这份知识. 一.书中的代码: <pre name="code" class="java">//:object/HelloDate.java package unit2; import java.util.Date; /** * The

查看SharePoint文档库是,显示层次目录,可以点击返回层次

在sharepoint 2013中,Documnet library(文档库)包含多层文件夹,当进入到文件夹后,返回指定层次了(例如返回上一层),需要用浏览器的返回. 使用起来不方便,而且浏览器的返回,会导致一些问题,不推荐普遍用户使用. 解决这个问题,可以做一个目录结构,实现方法是:访问Document library 时, url 有个参数[RootFolder],记录了路径. 主要对[RootFolder]参数进行处理. 这里使用webpart实现.当然,也可以Javascript方式实现

eclipse中自动生成javadoc文档的方法

?这篇文章主要介绍了eclipse中自动生成javadoc文档的方法,是实用eclipse开发Java程序时非常实用的技巧,对于进行Java项目开发具有一定的参考借鉴价值,需要的朋友可以参考下 本文实例讲述了eclipse中自动生成javadoc文档的方法.分享给大家供大家参考.具体方法如下: 使用eclipse生成文档(javadoc)主要有三种方法: 1. 在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步. 在Jav

用IDEA生成javadoc文档

用IDEA生成javadoc文档 打开相应的选项面板 设置 -encoding是java代码编码,-charset是对生成文档所用的编码.-windowtitle就是对应html的<title>标签 1 -encoding UTF-8 -charset UTF-8 -windowtitle "test" 结果 原文地址:https://www.cnblogs.com/PikaBi/p/12264612.html