php chm生成工具,phpDocumentor PHP 文档生成 CHM

好久没写新东西了。

最近遇到很头疼的事，好多代码要维护，时间长了，自己写过的代码都想不起来。

要调用某个对象的方法，每次都要打开那个类定义的 PHP 文件，找到方法的定义部分，然后仔细看看参数列表才能想起来怎么用。

最麻烦的是，有时候想不起来那个方法是在哪个类里面定义的，必须得去代码根目录 grep ，然后等半天……

相对比的，我开发程序时，手边必备的几个文档：PHP手册、MySQL手册、HTML手册、CSS手册、Javascript手册，以及最近开始用的 ActionScript手册。这些都是 chm 版本的！

Chm 帮助文件有 2 个最大的好处，一个是索引，另一个是全文检索。

用索引可以一边输入，一边过滤掉不匹配的关键词，迅速定位到想要的那个函数名。

当不知道关键词是什么的时候，可以用 like 语句在 chm 文件里面的每一句话中匹配关键词。

原本，用 Zend Studio 也有代码提示和自动完成，不过这个用 Java 虚拟机运行的 IDE 实在是慢，受不了，也不习惯。

今天花了好长时间，研究 php 文档生成工具，找到了几个，主要都是生成 html 页面的，而且格式很难看，重要的是没有好用的索引，更没有全文搜索，没意思。

PhpDocumentor 支持 chm 生成，这个让我眼前一亮！

简单看了下官方文档，然后就下载了 zip 格式的压缩包，就是这个压缩包，浪费了我好长时间去调试错误！！

设定好 php 源码路径，再设置文档格式，选择 chm，输出了一堆文件，包含 hhc，hhp 等，这些是 chm 的“源码”，需要用 Windows 自带的 HTML Help WorkShop 进行编译，然后才能生成 chm。

而那个 zip 压缩包，居然是有严重 bug 的版本，生成的 hhc 文件，里面有一行错误代码，提示 contents.hhc.tpl 找不到！！！

最开始我没有意识到问题在这里，只是用 WorkShop 反复编译那堆 hhc 文件，总是不成功！我都有放弃的念头了。

后来仔细看错误提示，好像是 hhc 文件的问题，打开一看，才知道是上述原因。

再去 phpDocument 源码里面找 contents.hhc.tpl，真的没有！不过，却有 contents.hhc.tp 这个文件！！！

然后列了下目录，几十个文件，大部分都是 tpl 扩展名，而有几个文件是 tp！！！

靠！什么玩意儿，是程序员马虎了还是打包工具的问题？

重新下了个 tgz 版本的 phpDocument，问题全无，chm 编译顺利！

另外，默认编译的 chm 是不带搜索(全文检索)功能的，更改方式如下：

打开一个项目文件，单击“Project(项目)”选项卡的“Change project options(改变项目选项)”，在“Options(选项)”对话框的“Compiler(编译)”选项卡中选中“Compile Full Text Search Information(编译全文搜索信息)”即可。

附赠命令行范例：

$> php phpdoc -o CHM:default:default -d ../lib/ -t ../docs/ > ../php_doc.log

php chm生成工具,phpDocumentor PHP 文档生成 CHM相关推荐

java接口文档生成工具_接口文档生成
一.为什么要写接口文档? 1.正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要. 2.项目开发过程中前后端工程师有一个统一的文件进行沟通 ...
转帖“接口测试工具和接口文档生成”
最近在研究接口测试,然后在网上找工具来进行接口测试.现在主流使用的接口测试工具一般有:jmeter.postman.soapui.apipost jmeter可以进行接口测试和性能测试,但是对于做单纯 ...
Api文档生成工具与Api文档的传播（pdf）
点击查看apidoc生成文档demo 1 环境和工具 win10 apidoc:注释生成api文档 wkhtmltopdf:apidoc生成的是html,不适合传播,于是通过wkhtmltopdf将h ...
软件工程文档生成工具
在软件工程领域,产品工程文档通常主要包括实施方案.需求分析.软件设计.测试报告.用户手册等几种.这些文档中,通常要求内容丰富,能够体现整个软件工程大部分信息:易于理解,需要制作各种表格,绘制各种图形, ...
将doc文档生成html页面
小编在参与某个项目的时候,产品经理要求将产品的操作指南生成html页面的形式直接以链接的形式在管理后台中进行查看,当听到这个要求时小编是相当头疼啊,产品的操作指南将近百来页,不可能手动一页页做成htm ...
iOS - appledoc 文档生成
为什么80%的码农都做不了架构师?>>> 1.安装appledoc git clone git://github.com/tomaz/appledoc.git cd ./app ...
word文档生成目录的方法，word生成目录之后怎么修改页码
word文档生成目录步骤,包括撰写标题.层级化标题.插入空白页.引入目录四个步骤.word文档生成目录后怎么修改页码?自动生成的目录,可通过自动更新页码的方式修改页码,无须手动修改.接下来,以Micr ...
有关PHP文档生成工具---PHPDocumentor
1. 什么是phpDocumentor ? PHPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档.老的版本是 phpdoc, ...
.NET平台开源项目速览(4).NET文档生成工具ADB及使用
.NET平台开源项目速览(4).NET文档生成工具ADB及使用原文:.NET平台开源项目速览(4).NET文档生成工具ADB及使用很久以前就使用ADB这个工具来生成项目的帮助文档.功能强大,在学习 ...
.NET文档生成工具ADB[更新至2.3]
ADB2.3下载 ADB2.3源代码下载 Microsoft HTML Help Workshop下载注意:使用该软件需先安装Microsoft HTML Help Workshop 程序的注释 ...

php chm生成工具,phpDocumentor PHP 文档生成 CHM

php chm生成工具,phpDocumentor PHP 文档生成 CHM相关推荐

最新文章

热门文章