文档库建立php,PEAR：使用PHPDoc轻松建立你的PEAR文档

对于一个开发人员，文档总是最感到头疼的事情之一。而且，很可能你对待文档会采取截然不同的2种态度：

当你使用别人的代码库的时候，最希望得到的是它的技术文档，尤其是当时间很紧，而你又不得不硬着头皮去读那些生涩的代码的时候。

当写你自己的程序的时候，最不希望做的事情却是给它编写专门的技术文档，你会以种种理由给自己开脱：我的代码已经足够清晰了，完全不用再为它重新编写文档了……

也许是为了缓解这种矛盾，有很多工具可以帮助你，通过从源代码中抽取相应的注释，可以自动生成相应的api文档。java中的javadoc,perl中的pod2man。相比之下，php以前似乎缺乏相应的工具，不过，随着phpdoc的不断完善，这种局面已经大大改观。

在第一篇pear的编码规则中有一条，pear程序中的注释应该能够被phpdoc转换。由此可见，phpdoc在pear中的作用可不小。今天，我们将详细讨论phpdoc，这个优秀的pear程序。

PHPDoc是PEAR下面的一个非常优秀的模块，它的目标是实现类似javadoc的功能，可以为你的代码快速生成具有相互参照,索引等功能的API文档。如果你使用过javadoc生成的文档(如jdk的文档)，你会非常清楚，如果你没有用过，那么下面是一个phpdoc生成它自己的文档页面的截图：

从图上可以知道，phpdoc生成的文档和JAVADOC很相似，它有多种的索引方式：

Packageindex:这是按照模块来索引

Classtree:这是按照你的php类的继承关系，可以生成一个树状的索引

Modulegroups:这是按照模块划分

Elementlist:这是你的所有元素(类，方法，过程/函数，变量)的字母顺序的索引

本文原创发布php中文网，转载请注明出处，感谢您的尊重！

文档库建立php,PEAR：使用PHPDoc轻松建立你的PEAR文档_PHP相关推荐

使用PHPDoc轻松建立你的PEAR文档
PEAR:使用PHPDoc轻松建立你的PEAR文档潘凡 ( nightsailer@hotmail.com), 工程师, 北京赛迪数据有限公司简介: 对于一个开发人员,文档总是最感到头疼的事情之一 ...
PEAR：使用PHPDoc轻松建立你的PEAR文档
对于一个开发人员,文档总是最感到头疼的事情之一.而且,很可能你对待文档会采取截然不同的2种态度: 当你使用别人的代码库的时候,最希望得到的是它的技术文档,尤其是当时间很紧,而你又不得不硬着头皮去读那些 ...
php教程doc,PEAR：使用PHPDoc轻松建立你的PEAR文档-PHP教程,PHP应用
对于一个开发人员,文档总是最感到头疼的事情之一.而且,很可能你对待文档会采取截然不同的2种态度: 当你使用别人的代码库的时候,最希望得到的是它的技术文档,尤其是当时间很紧,而你又不得不硬着头皮去读那些 ...
MSDN Visual系列：在WSSv3中编程方式激活单个文档库的审核功能
原文:http://msdn2.microsoft.com/en-us/library/bb418730.aspx WSSv3有一个很强大基础结构,专门用来审核用户对页面,文档和列表项的访问.您可以在 ...
如何为SharePoint文档库、文件夹、文件单独设置权限
在这里使用截图的方式简单描述两个问题:设置SharePoint Server文档库权限和文档库中的文件夹权限一.设置SharePoint Server文档库权限 Figure 1 - 打开文档库后, ...
win7计算机我的文档,轻松转移Win7系统我的文档库保存位置
上次我们曾说过Win7系统临时文件夹会占用大量系统盘空间的问题,并教大家如何将Win7系统临时文件夹位置转移到其它分区,从而为系统盘节省空间.其实除了临时文件夹,Win7系统用户文件夹也是系统盘中&q ...
从SAP BPC中Entity维设计的理念考虑Web程序中类似文档库之类的设计该考虑的东西...
查看下图在SAP中关于Entity维度的设计,设计维的时候有所有者,审核者,查看者,H1,H2,H3和其他属性对于其他属性我们暂且不管,看看所有者,审核者,查看者,H1,H2,H3这几个属性设计对系 ...
基于Picture Library创建的图片文档库中的上传多个文件功能(upload multiple files)报错怎么解决？...
复现过程首先,我创建了一个基于Picture Library的图片文档库,名字是 Pic Lib 创建完毕后,我点击它的Upload 下拉菜单,点击Upload Picture按钮在弹出的对话框中 ...
创建文档库时指定文件夹（路径）
//templateList是作为模板的列表或文档库 SPList EnsureArchiveList( SPList templateList) { SPWe ...

文档库建立php,PEAR：使用PHPDoc轻松建立你的PEAR文档_PHP

文档库建立php,PEAR：使用PHPDoc轻松建立你的PEAR文档_PHP相关推荐

最新文章

热门文章