手机浏览 RSS 2.0 订阅 膘叔的简单人生 , 腾讯云RDS购买 | 超便宜Qcloud , 注册 | 登陆

netbeans and PHPdocs

首页 > PHP >

我不知道是我的PHPDOC版本有问题还是有我的netbeans版本有问题,反正,我在netbeans里调 用生成phpdoc没有成功
但是我在命令行下,以及WEB管理界面,我都成功生成了。

OK说一下我的步骤
1、下载phpdocumentor并解压到某个目录
2、修改phpdoc.bat,把set PHPCli的路径改成我的PHP实际路径
3、在命令行下运行phpdoc,会提示你选择哪一个INI文件,选择0.即使用默认的phpdocumentor.ini
4、然后运行。。phpdoc -d xxx -t xxx就over了。
这是最简单的方法
然后是进入WEB管理,这时候,要把phpdocument解压到WEB可访问的目录下,打开http://localhost/xxx/phpdoc.php会跳转到builder目录下
然后设置一下directoy目录和Target目录。同时也可以选择生成的格式,最后选择create,就直接创建成功了。。

然而我在官方的介绍下(视频)我却没有配置成功。。。不知道怎么回事,想知道官方是怎么下载的,可以到官方看一下视频。。。地址是:http://netbeans.org/kb/docs/php/screencast-phpdoc.html



如果觉得我说的简单,这里有一份比较详细的介绍:

http://gyxuehu.iteye.com/blog/582517
  1. 写文档是一项乏味却不得不做的工作,而编写API级的文档更是意味着大量的重复劳动和难以保持的一致性。这里我们要推荐给大家的,是支持PHP5语法分析的文档工具——phpDocumentor。  
  2.   
  3. 使用phpDocumentor不仅可以自动从代码中提取出函数和方法定义,还可以自动处理各个class之间的关系,并据此生成class tree。你还可以选择将文档生成html、chm或者pdf。有了phpDocumentor,文档工作变得轻松了很多。  
  4.   
  5.   
  6. 安装phpDocumentor  
  7.   
  8. 在pear下安装phpDocumentor是一件极其简单的事情,只需要在cmd窗口中cd 到php安装目录下,然后输入  
  9.   
  10. Pear install phpDocumentor  
  11.   
  12.   
  13. Pear就会自己下载并完成phpDocumentor的安装。  
  14.   
  15. 在phpDocumentor成功安装后,php安装目录下会多出来一个phpdoc.bat。这个文件就是我们用来生成文档的批处理文件了。  
  16.   
  17. 〈? 相关知识 ?〉   
  18.    
  19.   
  20. phpDocumentor是phpDoc的升级版本,是专门为支持php5语法而重写的文档工具,当你的php版本为5时,运行phpDoc.bat,它会自动去调用phpDocumentor。所以文章中的提到的phpDoc和phpDocumentor实际上是相同的。  
  21.   
  22. 在phpdoc.bat所在目录下,输入  
  23.   
  24. Phpdoc –h  
  25.   
  26. 会得到一个phpDocumentor的详细参数列表。  
  27.   
  28. 我们从其中选出几个常用的来看看:  
  29.   
  30. 〈? 命令解释 ?〉  
  31.   
  32. -f  
  33. 要进行分析的文件名,多个文件用逗号分割  
  34.   
  35. -d  
  36. 要分析的目录,多个目录用逗号分割  
  37.   
  38. -t  
  39. 生成的文档的存放路径  
  40.   
  41. -o  
  42. 输出的文档格式,结构为输出格式:转换器名:模版目录,例如:HTML:frames:phpedit   
  43.    
  44. 我们会用到的就这几个了,其他的命令请大家阅读help的提示信息。  
  45.   
  46. 试用phpDocumentor  
  47.   
  48. 下面我们就以pear中的phpUnit2为例,演示一下如何使用phpDocumentor来生成文档。  
  49.   
  50. 首先,把我们需要的参数确定下来:  
  51.   
  52. 〈? 命令参数 ?〉  
  53.   
  54. -d  
  55. C:Program FilesEasyPHP5phpPEARPHPUnit2  
  56.   
  57. -t  
  58. C:Program FilesEasyPHP5phpphpunit2doc  
  59.   
  60. -o  
  61. HTML:frames:phpedit   
  62.   
  63.   
  64. 根据上边的参数,我们组合出下边的命令:  
  65.   
  66. Phpdoc -d “C:\Program Files\EasyPHP5\php\PEAR\PHPUnit2” -t “C:\Program Files\EasyPHP5\php\phpunit2doc” -o “HTML:frames:phpedit”  
  67. 运行上边的命令后,phpDocumentor开始解析源文件并输出工作信息。  
  68.   
  69. 命令运行完成后,我们的文档就已经生成好了。 进入我们指定的目标目录,用浏览器打开index.html就可以看见生成的文档了。 文档界面由frame分成了三个部分,左上是包信息,左下是导航信息,右边则是详细的信息呈现页。  
  70.   
  71. 上边的图很清楚地描述出了文档的内容: (膘叔:原文就没有图。)
  72.   
  73. 索引、函数列表、类列表、文件列表和子包。  
  74.   
  75. 点击上边的class(es)链接,我们可以清晰的看见整个包的class tree。  
  76.   
  77.    
  78.   
  79.   
  80. 我们点击其中一个class,就进入了class的描述页面。  
  81.   
  82. Class描述页面主要包含以下几方面内容:  
  83.   
  84.    
  85.   
  86. l 描述:版权、作者、类层次等  
  87.   
  88. l 类变量  
  89.   
  90. l 类常量  
  91.   
  92. l 方法  
  93.   
  94. l 继承的变量  
  95.   
  96. l 继承的方法:非常有用的一个功能  
  97.   
  98. 怎么样,是不是很详细呢?如果要生成chm,可以把前边的-o参数改为”CHM:default: default”,这样phpDocumentor会为你生成好chm项目文件,只要用微软的chm工具进行编译就可以得到可用的chm文件了。  
  99.   
  100.   
  101. 用phpDocumentor为自己的代码生成文档  
  102.   
  103. 虽然phpDocumentor可以自动从代码中分析出一些信息,但是,要形成一份详尽的文档还是需要我们在编码中进行配合的。为了让phpDocumentor读懂我们的代码,我们需要注意一些编码规范和在注释中增加一些tag:  
  104.   
  105. 〈? Tags ?〉  
  106.   
  107. @author  
  108. 作者信息  
  109.   
  110. @const  
  111. 由define定义的常量  
  112.   
  113. @deprecate  
  114. 不建议使用的API  
  115.   
  116. @global  
  117. 全局变量  
  118.   
  119. @package  
  120. 包信息  
  121.   
  122. @param  
  123. 函数参数  
  124.   
  125. @return  
  126. 返回值  
  127.   
  128. @see  
  129. 参考函数  
  130.   
  131. @since  
  132. 引入时间  
  133.   
  134. @static  
  135. 静态变量  
  136.   
  137. @var  
  138. 类成员变量   
  139.   
  140. 这里只是简单的列出了常用的一些Tag,大家可以阅读phpDocumentor的文档,里边有非常详细的编码规范。关于phpDocumento就介绍到这里,希望大家都能好好利用这个工具来规范自己的文档。  
  141.   
  142. PS:phpDocumentor也有Web界面的,你可以访问http://phpdoc.org获取Web版本。Web版本的安装很简单,直接放到web可以访问的目录就可以运行了。  
  143.   
  144.   
  145. 〈? 环境要求 ?〉  
  146.   
  147. PHP:5.0.0  
  148.   
  149. OS: 平台独立,本文演示OS为windows   

这里还有一篇操作步骤的:

http://xieye.iteye.com/blog/229131
  1. phpDocumentor有两种正式的安装方法。  
  2. (以下都翻译自pear.php.net的文档, -- xieye --)  
  3.   
  4. 第一种方式是从pear.php.net 或 sourceforge.net下载压缩包并解压。另一种方式是通过pear安装  
  5.   
  6. 注意:以下假定用户使用PHP5,window系统!  
  7.   
  8. 第一种方法:  
  9. 下载后,如果希望使用命令行接口,解压到任意路径(假设在C:\Program Files\),  
  10. 修改C:\Program Files\PhpDocumentor-1.4.2\phpdoc.bat  
  11. 把第一行修改SET phpCli=C:\usr\local\php\cli\php.exe  
  12. 令等号右边的值为php.exe的路径  
  13. 我的机器是SET phpCli=D:\php5\php.exe  
  14.   
  15. 在命令行输入C:\Program Files\PhpDocumentor-1.4.2\phpdoc,其实是一个批处理文件  
  16. 会出现一个dos界面,给你选择ini文件。  
  17. 后面就不知道了。  
  18.   
  19.   
  20. 如果想使用web接口,你必须先把apache和php装好,把PhpDocumentor-1.4.2这个文件夹  
  21. 拷贝到文档根目录下,然后在浏览器url栏输入:  
  22. http://localhost/PhpDocumentor-1.4.2/phpdoc.php  
  23. 然后浏览器会自动跳转,选择index.html,后面的操作就很简单了。  
  24.   
  25.   
  26.   
  27.   
  28.   
  29. 第二种方法:通过pear安装  
  30. 进入dos的php目录  
  31. 输入pear install -a PhpDocumentor  
  32.   
  33. 如果想使用web接口,则必须首先改变一个配置,  
  34. pear config-set data_dir /path/to/document_root/pear  
  35. 最后的路径应该是/php文档根路径/pear  
  36. (也可以在web接口中改变这个值)  
  37.   
  38. 我没在第二种方法的web接口试验成功。  
  39.   
  40.   
  41. 如果使用web接口的话,还有选择,  
  42. 一种是每次都选择输入文件,输出文件之类。  
  43. 另一种是使用一个配置文件,里面把什么都定义好,  
  44. 进入页面后,先选择这个配置文件,然后点击“创建”按钮,  




本站采用创作共享版权协议, 要求署名、非商业和保持一致. 本站欢迎任何非商业应用的转载, 但须注明出自"膘叔", 保留原始链接, 此外还必须标注原文标题和链接.

Tags: netbeans, phpdoc

« 上一篇 | 下一篇 »

只显示10条记录相关文章

phpstorm试用 (浏览: 18970, 评论: 2)
scala之hello world调试成功【基于netbeans IDE】 (浏览: 18603, 评论: 0)
JDK最新版本下载及JDK安装与配置 (浏览: 16449, 评论: 0)
netbeans更换jdk路径 (浏览: 14752, 评论: 1)
Android 手机上的 Scala 编程 (浏览: 14282, 评论: 0)
写在NetBeans IDE 6.9.1 发布时 (浏览: 14060, 评论: 2)
使用UBUNTU作为常用开发环境 (浏览: 12427, 评论: 2)
杂七杂八:editplus and netbeans (浏览: 12043, 评论: 4)
NetBeans在Ubuntu下调整界面模糊 (浏览: 11493, 评论: 1)
感慨,丢人,自卑 (浏览: 9798, 评论: 0)

发表评论

评论内容 (必填):