关于如何生成Java文档

一.生成Java文档,要明白Java注释内容,如果不知道,可以去看上一篇文章。

二.Java系统提供的javadoc工具可以根据程序结构自动生成注释文档。当程序修改时可方便及时更新生成的注释文档。javadoc.exe工具存在于JDK的bin目录下,使用javadoc将读取.java源文件中的文档注释,并按照一定的规则与Java源程序一起进行编译,生成文档。

三.javadoc常用标记:

(上面截图来自javadoc的百度百科,读者也可以自己去百度百科看),除了这些,还有一些不常用的标记,这里就不列举了。

四.javadoc命令的一般形式:

javadoc [options] [packages] [sourcefiles] [@files]

在命令中有4组可选项,方括号本身不是命令的一部分。命令行的每个选项之间用一个或多个空格分开。各组选项的用途:

①options,指定执行javadoc时的命令选项,如果想显示标准命令选项,可以使用如下命令:javadoc -help

②packages,需要处理的一系列包名,名字之间用一个或多个空格分开

③sourcefiles,一系列用空格分隔的源文件名,可以使用通配符,如果想指定当前目录的所有源文件,可以使用*.java表示

④@files,用空格分隔的一个或多个源文件的名字,也可以是一个或多个包,每个文件必须用@做为前缀符

五.Javadoc中options选项很多,下面列出了常用的选项:

①-author,生成@author标记

②-version,生成@version标记

③-package,把文档输出到包、公有的或受保护的类和成员上

④-public,把文档输出到公有类和成员上

⑤-protected,把文档输出到公有类和受保护的类以及公有的类成员上

⑥-private,把所有类和成员生成文档注释

⑦-d directoryName,使javadoc生成的HTML文件存储在指定的目录下。默认为当前目录

六.示例

Java代码:

注意:

①这个类一定要使用public修饰,这表示对外开放的,这样javadoc才能从中提取出注释文档;

②类中的方法(包括构造)如果使用private修饰,即本类中的内部调用类,则在生成的注释文档中不会显示这个方法,因为private代表它不对外开放。

在命令提示符下操作(先进入源程序目录):

①javadoc -d myhelp -author -version ArrayTool.java

(这里myhelp是指生成的帮助文档将放在源目录的myhelp子目录下面,这个目录也可以自己设置,只要是完整的路径就可以,如果写了本地磁盘上没有的文件夹,则myhelp文件夹将自动生成)

时间: 2024-11-29 06:19:06

关于如何生成Java文档的相关文章

如何为我们的程序编写开发文档——Java文档注释

Java文档注释是用于生成Java API文档的注释,通过在程序中的类.属性.方法部分加上注释,就可以用javadoc命令生成漂亮的API文档,是程序员进阶的必备技能. 注意,文档注释只说明紧跟其后的类.属性或者方法. Javadoc文档生成命令为: -author和-version可以省略. 根据在文档中显示的效果,文档注释分为三部分.举例如下: 第一部分是简述.如下图中被红框框选的部分: 简述部分写在一段文档注释的最前面,第一个点号 (.) 之前 (包括点号). 第二部分是详细说明部分.该部

读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

利用Java动态生成 PDF 文档

利用Java动态生成 PDF 文档,则需要开源的API.首先我们先想象需求,在企业应用中,客户会提出一些复杂的需求,比如会针对具体的业务,构建比较典型的具备文档性质的内容,一般会导出PDF进行存档.那么目前最佳的解决方案,你可能会想到 iText ,对没错... iText+(Velocity / Freemarker)可以实现.不过据我熟悉,iText本身提供的HTML解析器还是不够强大,许多HTML标签和属性无法识别,更悲催的是简单的CSS它不认识,排版调整样式会让你头大的.不要失望,接下来

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

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

java使用freemarker 生成word文档

java 生成word文档 最近需要做一个导出word的功能, 在网上搜了下, 有用POI,JXL,iText等jar生成一个word文件然后将数据写到该文件中,API非常繁琐而且拼出来的样式也不美观,于是选择了另一种方式----feemarker基于word模板的导出方式, 这种方式非常简单而且导出的样式美观, 其原理就是先做一个word模板, 该模板中变量数据用${xxx}这种方式填写, 然后再导出时只需读取模板然后用相应的数据替换其中的${xxx}即可. 一,简单模板导出(不含图片, 不含

java通过freemarket生成word文档

1.使用freemarker的原因是:由于POI和ITEXT在处理复杂word文档格式时欠缺,尤其在生成WORD文档时,(其他处理word的工具需要动态加载windows动态链接库,有些还要收费),并且需求要在WORD指定位置插入图片,所以在参考了POI和ITEXT官网处理WORD和网络上其他处理WORD的工具后,发现freemarker可以通过设定WORD模板,经过处理生成ftl文件后,可直接通过freemarker的工具jar包可以生成指定位置的WORD文件.(不过用模板生成有个别缺点,一是

JAVA 文档注释,类的说明,HTML说明文档的生成

有的时候,我们会写一些类,编译成.class文件,给别人使用,那么,别人不知道这个类有哪些方法,如何调用. 所以我们需要做一个类的说明文档. 可以采用在.java类里面进行注释,通过注释来生成类的说明文档的方法. 一..java中注释的写法: Test1.java /* 文档注释 */ /** 此类是对数组进行取最值,排序等操作的 @author 张三 @version 1.0 */ public class Test1{ /** 取Int数组里面的最大值 @param arr 传入一个int数

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

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

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

JAVA中注释有三种   1 单行注释 //+内容      2 多行注释  /* 内容 */  3 文档注释  /**内容*/       其中单行注释和多行注释是用于方法里面的注释 ,文档注释是用来注释类的成员和方法.   帮助文件是用多行注释实现的,用的程序是JAVA中jdk目录下bin目录JAVAdoc.exe. 首先 打开eclipose,找到一个需要生成帮助文档的工程.工程里面的类都是用多行注释标记了方法和属性的.比如 package java4_10; /** * * @autho