javadoc转pdf

‘壹’ jdk的所有命令，比如javac java javadoc 等的具体使用

JDK 常用命令
JDK 后，JAVAHOME 下会出现许多可执行的 exe 文件，它们的用途如下： 文件，它们的用途如下： javac：Java 编译器，将
Java 源代码换成字节代 ： 编译器， java：Java 解释器，直接从类文件执行 Java 应用程序代码 ： 解释器，
appletviewer(小程序浏览器 ：一种执行 HTML 文件上的 Java 小程序类的 Java 浏览器 小程序浏览器)： 小程序浏览器
javadoc：根据 Java 源代码及其说明语句生成的 HTML 文档 ： jdb：Java 调试器，可以逐行地执行程序、设置断点和检查变量 ：
调试器，可以逐行地执行程序、 javah：产生可以调用 Java 过程的 C 过程，或建立能被 Java 程序调用的 C 过程的头文件 ：
过程， Javap：Java 反汇编器，显示编译类文件中的可访问功能和数据，同时显示字节代码含义 ：
反汇编器，显示编译类文件中的可访问功能和数据， jar：多用途的存档及压缩工具，是个 java 应用程序，可将多个文件合并为单个 JAR 归档
：多用途的存档及压缩工具， 应用程序， 文件。 文件。 htmlConverter——命令转换工具。 ——命令转换工具。 ——命令转换工具
native2ascii——将含有不是 Unicode 或 Latinl 字符的的文件转换为 Unicode 编码字符的文 ——将含有不是 ——
件。 serialver——返回 serialverUID。语法：serialver [show] 命令选项 show 是用来显示一个简
——返回 —— 。语法： 单的界面。 键或"显示 按钮， 显示"按钮 单的界面。输入完整的类名按 Enter 键或 显示 按钮，可显示
serialverUID。 。 javac.exe 用法： 选项> 源文件> 用法：javac <选项 <源文件 选项
源文件 可能的选项包括： 可能的选项包括： -g 生成所有调试信息 -g:none 生成无调试信息 -g:{lines,vars,source}
生成只有部分调试信息 生成只有部分调试信息 -O 优化；可能妨碍调试或者增大类文件 优化； -nowarn 生成无警告 -verbose
输出关于编译器正在做的信息 -deprecation 输出使用了不鼓励使用的 API 的源程序位置 -classpath <路径
指定用户类文件的位置 路径> 路径 -sourcepath <路径 指定输入源文件的位置 路径> 路径
-bootclasspath <路径 覆盖自举类文件的位置 路径> 路径 -extdirs <目录 多个
覆盖安装的扩展类的位置 目录(多个 目录 多个)> -d <目录 指定输出类文件的位置 目录> 目录 -encoding
<编码 指定源文件中所用的字符集编码 编码> 编码 -target <版本 生成指定虚拟机版本的类文件 版本> 版本
-help Print a synopsis of standard options appletviewer.exe 用法：
用法：appletviewer <options> url
其中， 包括： 其中，<options> 包括： -debug 在 Java 调试器中启动 applet 小程序查看器
-encoding <encoding> 指定由 HTML 文件使用的字符编码 -J<runtime flag> 向
Java 解释器传递参数 -J 选

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

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

‘叁’ 怎样学习java

我可以结合自己的经验大致给你说一说，希望对你有所帮助，少走些弯路。

学习java其实应该上升到如何学习程序设计这种境界，其实学习程序设计又是接受一种编
程思想。每一种语言的程序设计思想大同小异，只是一些由语言特性的而带来的细微差别
，比如Java中的Interface，你几乎在以前的学习中没有碰到过。以下我仔细给你说几点

1。我们必须明确一个大方向，也就是说现在面向对象的编程范畴。尽管人工智能曾经有
所浪潮（看看Borland为什么有TurboPRolog），但未来5-10年工业界广泛承认并接受的
将是面向对象式的编程。

2。工业界目前最流行的面向对象编程语言就是C++和Java。所以基本上锁定这两个方向就
可以了。而且完全可以同时把握。

3。把握Java的精华特性而且一定要知道为什么。比如，Interface和multi-thread。用
interface是更好的多继续的模型，而多线程则是设计到语言一级的重要特性。要完全理
解interface是为什么，用多线程又有几种常用的编程模型。

4。理解了语言的特性是为什么了之后，就可以试着上升到设计这个层次，究竟学习语言
是要用的。目前比较好的开发模式是采用自定向下的面向对象的设计，加上MVC的模式（
你可以看一下我介绍的关于MVC的内容）。首先要找出最顶层的对象（这往往是最难的）
，然后一层一层往下递归
，记住每次应符合7+/-2的原则，因为我们人的短记忆就是这样。一般有图形用户界面的
应从界面开始设计。

5。有了基本设计模型后，可以学一些设计模式（Design Pattern)。这是目前证实很有效
的。比如体系结构模式（Layering分层，Pipe/Filter管道或过滤器），设计模式（有很
多，比如对象池Object
Pool、缓冲池Cache等），编程模式（比如Copy-on-Write）。懂了这些模式之后，就会对
系统的整体结构有很好的把握，而学术上也有倾向一个系统完全可以由各种模式组合而成
。前面提到的MT实际上就有好几种模式，把握后就不用自己花很多时间去试了。另外一个
很重要的领域就是并行
和分布式计算领域，大概有20种左右。

6。接下来就不能纸上谈兵了，最好的方法其实是实践。一般教科书上的例子并不能算是
实践，只能算是让你把握语言特性用的。而提倡做实际的Project也不是太好，因为你还
没有熟练的能力去综合各种技术，这样只能是你自己越来越迷糊。我认为比较好的方法是
找一些比较经典的例子，
每个例子比较集中一种编程思想而设计的

7。结合前面学到的设计模式你就可以很好的理解这些经典的例子。并且自己可以用他来 实现一些简单的系统。假如可以对他进行进一步的修改，找出你觉得可以提高性能的地方 加上自己的设计，那就更上一个层次了，也就会真正地感到有所收获。

8。好象以上谈的跟Java没什么关系，其实我们早就应该从单纯的学习语言到真正的学习 好编程的领域。学习技术是没有止境的，你学习第一种语言可能要半年时间，以后每种语言都不应该超过两个月，否则你会觉得学习语言是包袱，是痛苦我们的学习，我们的学习最重要的是实战软件的开发，所以建议在刚刚开始学习的时候，多找一些项目来研究，很多学校都有免费的课程，一般都会有提供小项目实战的，如果你们没有找不到，可以加我建立的一个交流群先加上670另外还有025最后加上447 这样你就可以找到组织，在群里大家都会提供很多小项目帮助大家成长的，你不来我们没有损失，损失的是你。

9。学习是为了用的，是为了让你的程序产生价值典

‘肆’ javadoc 怎么转为excel

用POI解析Excel，解析好后转成xml，在输出到html就可以了
类似这样，sheet是工作区，column是行，cell是单元格
不过这样这样的话merge过的单元格可能比较难表示
<sheet>
<column>
<cell />
<cell />
</column>
</sheet>

‘伍’ 如何利用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文档注释

如何写Java文档注释(Java Doc Comments)

本文翻译自How to Write Doc Comments for the Javadoc Tool，但是精简了一些私以为不重要的东西

本文不讨论如何使用javadoc工具自动生成文档的方法，而是主要探讨应该如何去写文档注释

业余时间整理，难免有遗漏或错误，如有发现欢迎指正

转载地址：网页链接

文档注释概览

“文档注释”(Java Doc Comments)是专门为了用javadoc工具自动生成文档而写的注释，它是一种带有特殊功能的注释。

文档注释与一般注释的最大区别在于起始符号是/**而不是/*或//。

比如：

/**这是文档注释*/

/* 这是一般注释*/

// 这是一般注释

在一些IDE（比如Eclipse）中，文档注释会以不同于普通注释的颜色高亮显示。

此外，文档注释只负责描述类(class)、接口(interface)、方法(method)、构造器(constructor)、成员字段(field)。相应地，文档注释必须写在类、接口、方法、构造器、成员字段前面，而写在其他位置，比如函数内部，是无效的文档注释。

文档注释采用HTML语法规则书写，支持HTML标记(tag)，同时也有一些额外的辅助标记。需要注意的是，这些标记不是给人看的（通常他们的可读性也不好），他们的作用是为了javadoc工具更好地生成最终文档。所以，虽然有些标记写起来麻烦且看着不直观，还是要老老实实按规矩写滴。

原文地址：网页链接

‘柒’ 如何快速编写api文档

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

推荐使用的是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中的数据是对象类型。则需要描述对象中字段的名称、类型、长度、不能为空、默认值、说明。以表格的方式来表达最好。

示例：



五、接口工具

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

‘捌’ 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中的数据是对象类型。则需要描述对象中字段的名称、类型、长度、不能为空、默认值、说明。以表格的方式来表达最好。

示例：



五、接口工具

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

‘玖’ php网站修改工具

PHP Expert Editor 是一个容易使用的 PHP 开发工具，它的功能照顾到初级者及专业开发人员。基于Windows平台的PHP Expert Editor是一个PHP语言的集成开发环境(IDE)。PHP Expert Editor为PHP高手提供了许多方便、实用的特性，它还为初学者提供了诸如语法检查、代码浏览、内嵌FTP、代码库管理、代码模版等易用的功能。内建的 http server 用作测试及除错(你也可以使用其他 http server), PHP 语法检查, FTP 功能, 程式码样板等功能。

PHP Expert Editor 适合PHP初学者和高级开发人员，它包括一个内部HTTP服务器和脚本器，可以进行语法检查，测试PHP代码等。

先安装后phpxedit_42.exe后，然后将目录下的phpxedit.exe覆盖到安装目录。

PHP Expert Editor 官方有4.3版本下载，但是杀毒软件居然报毒，所以还是把我收藏的4.2中文版奉献出来，完美汉化破解版，用着舒心。

一设计工具

UML和相关设计工具

-ArgoUML

UML绘图工具，支持PHPstub生成。(commercialspinoffisPosideon)–Java编写。

-UmbrelloUML

UML绘图工具，支持PHPstub生成。需要Unix/KDE。

-Dia

支持UML的绘图工具-使用AutoDia生成PHP。

-XMI2PHP

从XMI文档生成PHP代码，用XML描述UML的一种形式。

二编码工具

推荐的IDE/编辑器

-PHPEclipse

EclipseIDE的PHP插件

-PHPEdit

可能是Windows下最好的免费IDE了

-JEdit

支持PHP的IDE(plusloadsmore)。Java编写，所以平台保持独立。

-Jext

JEdit的孪生兄弟。

-gPHPEdit

Gnome/Linux下最好的(?)PHP编辑器。

-SciTE

跨平台编辑器

-PHPModeforEmacs

UnixEMACSIDE的PHPMode

三测试工具

Debuggers和Profilers

-XDebug(推荐)

出色的.debugger和profiler扩展

-AdvancedPHPDebugger

GeorgeSchlossnagle的debugger

-PEAR::Benchmark

用PHP写的Benchmarking和profiling工具

-DBG

PHPDebugger

单元测试框架

-SimpleTest(推荐)

关于mockobjects出色的文档和支持

-PEAR::PHPUnit

四部署工具

构建/部署工具

-PEARPackageManager(推荐)

允许你安装PEARpackages(通过网络)，还能将你的代码打包用于安装。在命令行下执行http://pear.php.net/go-pear运行。PHP编写。

-PEAR::PackageFileManager

自动生成PackageManager使用的package.xml文件。PHP编写。

-Phing

PHP的构建工具，相当于ApacheANT。在构建大型项目时值得研究。PHP编写。

-ZZ/OSSInstaller

基于PHP的安装向导，用于专业的PHP模块化应用的发布。

加速器

-TurckMMCache(强烈推荐)

集成OPCODECache，scriptencoder，profiler和动态内容缓存(readpersistence)于一体。提供Windows版本。

-PHPAccelerator(推荐)

OPCODECache

五管理工具

文档生成工具

-phpDocumentor(推荐)

用源代码注释中生成API文档(像Javadoc)。输出可以被“模版化”，还支持HTML，PDF和CHM格式。PHP编写。

-PHPXref(推荐)

创建源代码的“交叉引用”，使你能够看见一个变量/方法/函数在哪里声明以及在哪里被引用。Perl编写。

版本控制工具(此部分为Easy添加)

-CVS

开放源代码的版本控制系统，很多大型项目，包括PHP本身，都用它管理代码。

-CVSNT

用于WindowsNT(XP也可以)的CVS服务器程序

‘拾’ 如何运用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类。笔者做了一个简单的表格示例