JAVA如何在eclipose中生成帮助文档

JAVA中注释有三种   1 单行注释 //+内容      2 多行注释  /* 内容 */  3 文档注释  /**内容*/

      其中单行注释和多行注释是用于方法里面的注释 ,文档注释是用来注释类的成员和方法。

  帮助文件是用多行注释实现的,用的程序是JAVA中jdk目录下bin目录JAVAdoc.exe。

首先 打开eclipose,找到一个需要生成帮助文档的工程。工程里面的类都是用多行注释标记了方法和属性的。比如

package java4_10;
/**
 *
 * @author 我
 *
 */
public class DEpt {
private int age;
public String name;
public String master;
/**
 * 修改器,可以完成私有属性的修改
 * @param age 年龄
 */
public void setAge(int age){
    this.age = age;
}
/**
 * 访问器,可以得到私有属性的值
 * @return  年龄
 */
public int getAge(){
    return this.age;
}
public void setName(String name){
    this.name = name;
}
public String getName(){
return this.name;
}
}

然后在工程上点击右键找到 Export选项,在如下对话框依次选择 java—————javadoc

双击javadoc跳转如下对话框

在Destination下选择要生成的帮助文件保存位置

选择Java中javadoc.exe程序路径 单击finish就自动生成帮助文件

然后在你保存帮助文件的地方就有了如下文件

然后点击index.html选择你想要查看的包的类,就可以查看帮助文档了

原文地址:https://www.cnblogs.com/jiangximing/p/8847577.html

时间: 2024-10-09 23:21:34

JAVA如何在eclipose中生成帮助文档的相关文章

读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

Python sphinx-build在Windows系统中生成Html文档

看到前同事发布的"Markdown/reST 文档发布流水线"基于TFS.Docker.Azure等工具和平台进行文档发布的介绍说明,不得不在心中暗暗竖起大拇指.这套模式,实现了文档编写后版本管理.发布.存档.分享的高度自动化,它不仅仅可以应用在文章中介绍的技术文档发布模式,同样也适用于我们大多数web.app等软件生命周期过程模式.DevOps一词的盛行,绝对不是软件行业中又一个流行语的鼓吹和炒作,而是软件过程的一种发展和进化.结合自动化平台.Docker.云平台等优秀技术和产品.软

Java iText使用PDF模板生成PDF文档

我们系统需要生成一个可以打印的PDF文档,老板给了我一个Word文档,按照这个Word文档的格式生成PDF文档. 第一步:下载AdobeAcrobat DC,必须使用这个来制作from域. 第二步:使用AdobeAcrobat DC将Word导成PDF文档. 第三步:由于还要加水印的效果,所以还是使用AdobeAcrobat DC来添加水印,非常方便: 添加水印的方法:使用AdobeAcrobat DC打开PDF文档,"工具"->"编辑PDF"->&qu

Java中生成帮助文档

如何在Java中使用注释 在编写程序时,经常需要添加一些注释,用以描述某段代码的作用. 一般来说,对于一份规范的程序源代码而言,注释应该占到源代码的 1/3 以上.因此,注释是程序源代码的重要组成部分,一定要加以重视哦! Java 中注释有三种类型:单行注释.多行注释.文档注释 运行结果:?Hello Imooc! 看:被注释的代码块在程序运行时是不会被执行的~~ 我们可以通过?javadoc?命令从文档注释中提取内容,生成程序的 API 帮助文档. 打开首页,查看下生成的 API 文档 PS:

170120、java 如何在pdf中生成表格

1.目标 在pdf中生成一个可变表头的表格,并向其中填充数据.通过泛型动态的生成表头,通过反射动态获取实体类(我这里是User)的get方法动态获得数据,从而达到动态生成表格. 每天生成一个文件夹存储生成的pdf文件(文件夹的命名是年月日时间戳),如:20151110 生成的文件可能在毫秒级别,故文件的命名规则是"到毫秒的时间戳-uuid",如:20151110100245690-ece540e5-7737-4ab7-b2d6-87bc23917c8c.pdf 通过读取properti

如何在CODESOFT中自定义删除文档备料

CODESOFT 2015是先进的标签设计与集成软件.在使用CODESOFT制作条码标签时,为方便省时,我们可以事先创建自己的文档模板,保存它们以供将来使用.接下来,小编就讲讲CODESOFT 2015自定义备料创建与删除的方法. 查看更多内容请直接前往:http://www.codesoftchina.com/faq/zidingyi-beiliao.html CODESOFT 2015自定义备料的创建: 1.在CODESOFT 2015自定义备料之前,您必须先选择用于生成文档的打印机型号.选

Java Web项目中使用Freemarker生成Word文档

Web项目中生成Word文档的操作屡见不鲜,基于Java的解决方案也是很多的,包括使用Jacob.Apache POI.Java2Word.iText等各种方式,其实在从Office 2003开始,就可以将Office文档转换成XML文件,这样只要将需要填入的内容放上${}占位符,就可以使用像Freemarker这样的模板引擎将出现占位符的地方替换成真实数据,这种方式较之其他的方案要更为简单. 下面举一个简单的例子,比如在Web页面中填写个人简历,然后点击保存下载到本地,效果图如下所示. 打开下

velocity模板技术生成word文档

本文介绍采用velocity技术在Java中生成word文档的方法. 1.新建一个word文档,编辑内容如下: 2.将上述word文档另存为htm格式的文件 3.新建一个Java Project项目velocityTest,加入Velocity所依赖的Jar包velocity-dep-1.5-beta2.jar. 4.在src目录下新建一个velocity.vm文件,将第二步生成的velocity.htm用文本编辑器打开,复制内容到velocity.vm中.内容如下: <html xmlns:v

ASP.NET Web API从注释生成帮助文档

ASP.NET Web API从注释生成帮助文档 默认情况下,ASP.NET Web API不从Controller的注释中生成帮助文档.如果要将注释作为Web API帮助文档的一部分,比如在帮助文档的Description栏目中显示方法注释中的summary,需要进行一些配置操作. 首先在Visual Studio中打开Web API项目的属性页,在Build设置页,选中XML document file,输入将要生成的XML文件放置的路径,比如:App_Data\OpenAPI.XML. 1