如何使用phpdoc生成PHP文档

1. 下载phpdoc

官网地址（已经N久没更新了，不知道是不是不想干了）：http://www.phpdoc.org/；下载地址：http://sourceforge.net/projects/phpdocu/files/

2. phpdoc -h

文件下载后解压，然后进入解压目录，编辑 phpdoc/phpdoc.bat 文件确保文件运行时可以找到 php 程序。然后运行 phpdoc -h 来查看帮助信息。

3. 生成文档

phpdoc -d "C:/Documents and Settings/Administrator/My Documents/Workspace/php eclipse/codeslab/questions" -t "C:/Documents and Settings/Administrator/My Documents/Workspace/php eclipse/codeslab/questions/doc" -j on -ti "Question Parser Component" -s on -dn questions -dc questions

4. 参数说明

-d -t 分别代表输入和输出目录，即源码目录与生成文档目录；-j 指的是 Java 兼容模式，默认是 off，关闭着的（实际使用中，最好指定，否则生成的文档简直没法看）；-ti 标题；-s 生成代码，仅 php 4.3.0+ 版本有效，不需要生成源码可以忽略此项。-dn 和 -dc 是默认包名和类型名，如不指定则使用“default”字样，最好指定下，要不太难看了。

5. 截图

如何使用phpdoc生成PHP文档相关推荐

PHPDoc/PHPDocumentor生成API文档
PHPDocumentor是一个用PHP写的强大的文档自动生成工具,对于有规范注释的php程序,能够快速生成具有结构清晰.相互参照.索引等功能的API文档.旧版本是PHPDoc,PHPDoc是PEAR ...
导出swagger2生成的文档
百度了好多篇用法,没法用.特此记录一下一.下载项目下载https://github.com/Swagger2Markup/spring-swagger2markup-demo下的项目,保存,注意文 ...
php导出doc文件_PHP生成Word文档的方法
PHP生成Word文档的方法首先,请确保在你的Windows系统中已经安装并配置好了一个典型的WAMP环境.由于Interop纯粹是一个Windows的特性,我们将在Windows平台下搭建Apac ...
为TypeScript项目生成API文档
为TypeScript项目生成文档使用typedoc为TypeScript项目生成API文档. 1. 使用typedoc生成HTML文档需要安装 typedoc. npm i typedoc 可以 ...
PHP生成PDF文档的FPDF类
以前在PHP4的早期版本中用PDFlib生成PDF文档比较容易,现在升级到PHP5了,发现更麻烦了,装的PHP 5.2.4默认没有PHPlib,从php.net上找了一个,装上竟一直报错,开始以为是版 ...
干掉 Postman？测试接口直接生成API文档，这个文档工具真香！
欢迎关注方志朋的博客,回复"666"获面试宝典实不相瞒我的收藏夹里躺着很多优质的开源项目,我有个爱好平时遇到感兴趣的开源项目都会记录下来,然后有时间在慢慢研究.前几天刚给同事分享 ...
还在用Swagger生成接口文档？我推荐你试试它.....
点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试文章 JApiDocs是一个无需额外注解.开箱即用的SpringBoot ...
这个VS Code扩展可以自动生成Python文档字符串
机器之心报道编辑:魔王该扩展利用可处理编程语言和自然语言的预训练模型 CodeBERT,实现快速生成 Python 文档字符串的功能. Visual Studio Code(简称 VS Code) ...
RESTful之自动生成接口文档
REST framework可以自动帮助我们生成接口文档.[必须是继承自rest_framework才会自动生成文档] 接口文档以网页的方式呈现. 自动接口文档能生成的是继承自APIView及其子类的 ...

如何使用phpdoc生成PHP文档

如何使用phpdoc生成PHP文档相关推荐

最新文章

热门文章