java怎样生成文档_关于如何生成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文件夹将自动生成)

java怎样生成文档_关于如何生成Java文档相关推荐

swagger 扫描java文档_使用Javadocs生成Swagger文档
我想为现有的一组RESTful API构建Swagger文档.我有以下要求: 读取现有的Javadoc,以便可以在Swagger文档中使用它们. 到目前为止使用上面的插件我能够实现第1点.所以对于现有 ...
Java项目中利用Freemarker模板引擎导出--生成Word文档
应邀写的一篇文章:Java项目中利用Freemarker模板引擎导出--生成Word文档资源下载:https://download.csdn.net/download/weixin_41367523 ...
python 生成html文档,Python使用pyh生成HTML文档的方法示例
Python使用pyh生成HTML文档的方法示例来源:中文源码网浏览: 次日期:2018年9月2日 [下载文档: Python使用pyh生成HTML文档的方法示例.txt ] (友 ...
echarts4离线使用文档_适合写API接口文档的管理工具有哪些？
现在越来越流行前后端分离开发,使用ajax交互.所以api接口文档就变的十分有意义了,目前市场有哪些比较优秀的接口文档管理工具呢? 1.MinDoc 网址:https://www.iminho.me/ ...
java后台处理excel_java后台利用Apache poi 生成excel文档提供前台下载示例
之前在项目中会用到在java在后台把数据填入Word文档的模板来提供前台下载,为了自己能随时查看当时的实现方案及方便他人学习我写了这篇博客,访问量已经是我写的博客里第一了.于是乎我在学会用Java在后 ...
java pdf 首行缩进_java使用iText生成pdf文档的对齐方式
一.前言在企业的信息系统中,报表处理一直占比较重要的作用,本文将介绍一种生成PDF报表的Java组件--iText.通过在服务器端使用Jsp或JavaBean生成PDF报表,客户端采用超级连接显示或 ...
wms策略文档_内容策略：技术文档的新理念
wms策略文档我们是否可以首先同意文档很重要,而我们想要更好的文档呢? 好. 这样一来,我就不必为为什么要关心而写三段式的报告了,这样您就可以保留更多的时间来阅读它会花费您的时间. 为了生意! 作为 ...
word文档里怎么嵌入文档_如何在Microsoft Word文档中嵌入字体
word文档里怎么嵌入文档 When you email someone a copy of your Word document or PowerPoint presentation and the ...
springboot api文档_SpringCloud/SpringBoot - 自动生成API文档
SpringCloud/SpringBoot 的项目一定要前后分离,这就需要一个API文档生成的工具,后端一定要和前端或者是移动端对接接口,那么问题来了,接口是不是要自己写给他们看,一般的会采用Exc ...
python 自动生成word文档,用 Python 自动生成 Word 文档
当然要用第三方库啦 :) 使用以下命令安装: pip install python-docx 使用该库的基本步骤为: 1.建立一个文档对象(可自动使用默认模板建立,也可以使用已有文件). 2.设置文 ...

java怎样生成文档_关于如何生成Java文档

java怎样生成文档_关于如何生成Java文档相关推荐

最新文章

热门文章