「javadoc转pdf」java生成javadoc

今天给各位分享javadoc转pdf的知识，其中也会对java生成javadoc进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

• 1、如何将jar包中的javadoc转换成chm文件
• 2、如何利用doxygen生成pdf文档
• 3、如何运用Java组件itext生成pdf
• 4、java接口文档怎么写

如何将jar包中的javadoc转换成chm文件

使用jd2chm来生成chm帮助文档

使用原版jd2chm_exe_03转换成chm

原版jd2chm_exe_03需要通过官网下载不过现在我这是不可以访问的，只能通过代理来访问下载工具。（不要担心，最后我会把所有的工具打包供大家下载）。下载解压后就是一个jd2chm.exe文件，怎么使用？很简单，就是把这个文件放到需要生成Javadoc的目录下，必须保证同一个目录下一定要有index.html，不然不可生成，单击，或者在cmd命令中打开exe，填写project name和title即可。

生成英文版本如下

如何利用doxygen生成pdf文档

在代码中加入文档 这个是第一步,也是最重要的一步,直接影响着文档的优与劣.

Doxygen是一个比较成熟的工具了,它有非常详细且专业的文档.

文档是写在代码当中的,以注释块的形式,为了区分代码中的正常注释,访文档需要用特殊的形式的注释块来呈现.Doxygen支持多种文档注释块:

Javadoc形式的:/** * ... */QT形式的/*! * ... */或者,这样/// /// ... ///或者,这样//! //! .. //!后二种有点非主流,不建议使用.推荐使用前面二种.当然,配置了某些特殊的选项也可以使用其他格式.

当Doxygen看到这种形式的注释块时就会把它从代码中抽取出来,生成HTML形式的文档.

为了让文档更且有可读性,表达出更多的信息,Doxygen就定义了很多的命令,常用的有:

\file 告诉Doxygen这是某个文件的文档块\enum 给一个enum类型加文档\struct 给一个结构体加文档\param 函数的参数\return 函数的返回值\see 交叉参考\brief 简介,用于概览时控制在一行以内,可以空一行,然后写更多的详细的内容\code \endcode 示例代码\note 注意事项\par HTML中的p 需要注意的是,这些命令也可以用javadoc格式的来写如@file, @enum, @return等.但建议用标准格式,因为\只需要敲一下,而@需要敲二下,另外就是并不是所有的命令都支持javadoc格式.

还有就是如果想写交叉引用可以在前面加个#就会自动转为相应的链接,直接上个例子就都明白了:/** * \brief Obtain current list of path * * \param [out] paths a pointer to an array of strings * \param [out] count indicating the count of path. * * \note * This function will allocate memory for path array. So caller must free the array, but should not free each item. * * \return #API_RESULT_CODE indicating whether this call success or failed. * * \par Sample code: * \code * char **path = NULL; * int count = 0; * test_get_paths(path, count); * // use the path * free(path); * path = NULL; * \endcode */ int test_get_paths(char ***paths, int *count);配置Doxygen Doxygen需要一个配置文件来告诉Doxygen一些选项.配置文件就是一个纯文本文件,格式跟标准的Linux配置文件一样:一行一个配置项,前面是配置项的名字,然后是等号后面就是配置项的值了.以#开头都是注释.Doxygen的选项特别的多,不可以手动的去写,通常都是编辑一个现有的模板,这个模板可以用Doxygen来生成:

doxygen -g config-filename

PROJECT_NAME 项目的名字,一定要改成你项目的名字PROJECT_NUMBER 编号,通常使用项目的版本号OUTPUT_DIRECTORY 文档输出存放目录,建议修改,比如docPROJECT_BRIEF 项目的描述,会出现文档每一页的上面,控制在一行80字符内(越短越好)EXTRACT_*** 打头的选项要仔细读,如果是API文档,则这些全都要设成NO,这样就仅抽取特定文档块内的内容. 其他的选项都可以不改,用默认的就成.

生成文档 这步最简单,如果前面都就绪了,仅需要运行命令即可:

doxygen config-filename

后,文档就会出现在所指定的输出目录中.

doxygen会打印出日志信息.为了保证质量,最好把把的Warning都修正掉.(这跟修正代码的所有编译警告一个道理).上面例子生成的文档:int test_get_paths(char *** paths, int * count ) Obtain current list of path. Parameters:[out]pathsa pointer to an array of strings[out]countindicating the count of path.Note:This function will allocate memory for path array. So caller must free the array, but should not free each item.Returns:API_RESULT_CODE indicating whether this call success or failed.Sample code:char **path = NULL; int count = 0; test_get_paths(path, count); // use the path free(path); path = NULL; 完整示例下载

如何运用Java组件itext生成pdf

首先从iText的官网下载这个开源的小组件。

iText官方网站

Java版iText组件

Java版工具包

C#版iText组件

C#版工具包

这里笔者使用的是Java版itext-5.2.1。

将itext-5.2.1.zip压缩包解压缩后得到7个文件：itextpdf-5.2.1.jar(核心组件)、itextpdf-5.2.1-javadoc.jar(API文档)、itextpdf-5.2.1-sources.jar(源代码)、itext-xtra-5.2.1.jar、itext-xtra-5.2.1-javadoc.jar、itext-xtra-5.2.1-sources.jar

使用5步即可生成一个简单的PDF文档。

复制代码

1 // 1.创建 Document 对象

2 Document _document = new Document();

3 // 2.创建书写器，通过书写器将文档写入磁盘

4 PdfWriter _pdfWriter = PdfWriter.getInstance(_document, new FileOutputStream("生成文件的路径"));

5 // 3.打开文档

6 _document.open();

7 // 4.向文档中添加内容

8 _document.add(new Paragraph("Hi"));

9 // 5.关闭文档

10 _document.close();

复制代码

OK，搞定，不出问题的话就会在你指定的路径中生成一个PDF文档，内容是纯文本的“Hi”。

可是这样并不能完全满足我们的需求，因为通常我们要生成的PDF文件不一定是纯文本格式的，比如我现在要实现打印销售单的功能，那么最起码需要绘制表格才行，怎么办呢？且跟笔者继续向下研究。

在iText中，有专门的表格类，即PdfPTable类。笔者做了一个简单的表格示例

java接口文档怎么写

一些刚开始写接口文档的服务端同学，很容易按着代码的思路去编写接口文档，这让客户端同学或者是服务对接方技术人员经常吐槽，看不懂接口文档。这篇文章提供一个常规接口文档的编写方法，给大家参考。

推荐使用的是docway 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。

一、请求参数

1. 请求方法

GET

用于获取数据

POST

用于更新数据，可与PUT互换，语义上PUT支持幂等

PUT

用于新增数据，可与POST互换，语义上PUT支持幂等

DELETE

用于删除数据

其他

其他的请求方法在一般的接口中很少使用。如：PATCH HEAD OPTIONS

2. URL

url表示了接口的请求路径。路径中可以包含参数，称为地址参数，如**/user/{id}**，其中id作为一个参数。

3. HTTP Header

HTTP Header用于此次请求的基础信息，在接口文档中以K-V方式展示，其中Content-Type则是一个非常必要的header，它描述的请求体的数据类型。

常用的content-type：

application/x-www-form-urlencoded

请求参数使用“”符号连接。

application/json

内容为json格式

application/xml

内容为xml格式

multipart/form-data

内容为多个数据组成，有分隔符隔开

4. HTTP Body

描述http body，依赖于body中具体的数据类型。如果body中的数据是对象类型。则需要描述对象中字段的名称、类型、长度、不能为空、默认值、说明。以表格的方式来表达最好。

示例：

二、响应参数

1. 响应 HTTP Body

响应body同请求body一样，需要描述请清除数据的类型。

另外，如果服务会根据不同的http status code 返回不同的数据结构， 也需要针对不同的http status code对内容进行描述。

三、接口说明

说明接口的应用场景，特别的注意点，比如，接口是否幂等、处理是同步方式还是异步方式等。

四、示例

上个示例（重点都用红笔圈出来，记牢了）：

五、接口工具

推荐使用的是（以前叫小幺鸡） 写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。

关于javadoc转pdf和java生成javadoc的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。