`
javasogo
  • 浏览: 1815881 次
  • 性别: Icon_minigender_1
  • 来自: 北京
文章分类
社区版块
存档分类
最新评论

如何使用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/phpDocumentor来生成api文档

    PHPDoc和phpDocumentor是两个用于自动生成PHP API文档的流行工具。本文将详细介绍这两个工具的使用和相关知识点。 ### PHPDoc简介 PHPDoc是一种基于注释的文档生成标准,用于PHP源代码。它类似于JavaDoc,通过在...

    PHP文档规范及phpDoc指南-共享版

    本指南详细介绍了如何编写符合标准的PHP文档和注释,以及如何利用phpDoc工具进行文档自动生成。 1. 概述 在PHP开发中,良好的文档规范和注释习惯对于代码的维护和理解至关重要。它不仅有助于开发者理解代码的功能和...

    PHPWord,可以自动生成doc文档

    **PHPWord:自动生成doc文档的利器** PHPWord是一款基于PHP的开源库,它使得开发者能够在Web环境中方便地创建和编辑Microsoft Word(doc)文档。这个强大的工具允许程序员通过简单的API调用来生成复杂的文档,无需...

    php自动生成带图片附件的doc文档类

    生成带图片的doc文档。 详细描述: 选择服务器上任意一个或一组图片或者文件,与doc一起打包下载。图片和附件可以在和doc文档显示。 环境要求: php需要开启ZipArchive组件支持。一个tmp文件夹的写权限。 程序默认...

    基于PHP语言的MySQL文档生成工具

    压缩包内的文件“create.mysql.doc”很可能是一个执行脚本或者配置文件,用于启动或配置这个文档生成过程。用户可能需要根据自己的数据库环境修改这个文件,然后运行以生成定制化的数据库文档。 总结起来,这个基于...

    thinkphp生成word文档并导出

    本篇文章将详细解析如何使用ThinkPHP框架生成Word文档并进行导出。 首先,让我们了解`WordController.class.php`和`Wordmaker.class.php`这两个文件的作用。`WordController.class.php`是ThinkPHP的控制器文件,它...

    使用PHP生成word文档1

    在本文中,我们将探讨如何使用PHP生成Word文档。主要技术是通过HTML格式来构建文档内容,并利用PHP的输出缓冲机制(ob_start)来捕获和处理HTML数据,最终将其写入到.doc文件中。 首先,我们需要一个开发环境,这里...

    使用PHP生成word文档

    使用PHP生成word文档 一、 开发环境 1、环境搭建:Windows 7+Apache ...本案例主要使用纯HTML格式写入word文档的方式,利用ob_start把HTML页面先存储起来,然后再将其写入doc文档,从而实现使用PHP生成word文档的功能。

    php自动生成带图像的word文档类

    这种技术通常涉及到使用特定的PHP库或者类来处理Word文档的生成,使得在服务器端无需借助其他软件就能完成文档的制作。在Web应用中,这种功能可以用于自动化报告生成、数据导出或者用户自定义模板下载等场景。 描述...

    PHP 自动生成帮助文档工具1.0Beta版

    PHP 自动生成帮助文档工具1.0Beta版,欢迎大家测试使用。...extFunction.php扩展函数,phpdoc.php文档生成类文件。strConf.php注释匹配 数组。PHPWord.php,PHP生成word类文件PHPWord文件夹是phpword工具的函数库

    使用Doxygen生成文档

    Doxygen的注释语法与Qt-Doc、KDoc和JavaDoc兼容,允许开发者在代码中使用类似的注释风格来描述类、函数、变量等元素,进而自动生成结构化的文档。 1. **Doxygen的基本特性** - 开源和跨平台:Doxygen可在多个操作...

    phpdoc-vuepress::artist_palette:以漂亮的VuePress格式生成PHP API文档的模板

    PHPDoc-VuePress 用于以漂亮的VuePress格式生成PHP API文档的模板。 该软件包提供了一个phpDocumentor模板,用于生成代码的API文档,以将其集成到美观的项目中。 仅使用默认主题VuePress进行了测试。产品特点此模板...

    Laravel开发-addon-phpdoc

    1. **XML解析**:使用PHP内置的DOMDocument或类似库解析phpDoc生成的XML文件。 2. **数据提取**:从XML文件中提取出类、接口、方法、属性等的详细信息。 3. **数据处理**:将提取的数据转化为适用于Laravel的格式,...

    PHP学习PHPDOC1.docx

    PHPDoc 是一种专门为 PHP 语言设计的文档注释标准,它借鉴了 Javadoc 的概念,旨在为 PHP 代码提供结构化的、机器可读的注释,以便于生成 API 文档,同时也支持集成开发环境(IDEs)进行更智能的代码提示和错误检查...

    phpDocumentor2-developAPI文档生成器的库.zip

    如果你有之前运行phpdoc获得的structure.xml文件,那么小修改后重新生成文档的速度将提升80%。  简单就能创建模板,只需1小步和编辑3个文件。  兼容1代的命令行。例如 --directory, --file and --target  两...

    phpdoc-md:以降价格式生成文档

    phpdoc-md是一个从PHPDOC注释生成美观文档的工具。 它允许生成易于阅读的文档降价文件,并直接在github,gitlab或bitbucket网站上关注。 您可以在此工具生成的示例文档 该工具的意图与标准PHPDocumentator略有...

    基于PHP的PESCMS DOC文档管理系统 php版.zip

    【标题】"基于PHP的PESCMS DOC文档管理系统 php版.zip" 提供的是一个使用PHP语言开发的文档管理系统,名为PESCMS DOC。这个系统专为管理、存储和检索各类文档而设计,适用于企业或组织内部的信息管理和知识共享。 ...

    api-doc-php:根据接口注释自动生成接口文档

    根据接口注释自动生成接口文档 演示地址 开源地址: 扩展安装: 方法一:composer命令 composer require itxq/api-doc-php 方法二:直接下载压缩包,然后进入项目中执行 composer命令 composer update 来生成自动...

    PHP文档编写和编码规范

    PHP文档通常采用PHPDoc和DocBook等标准化格式,这些格式使得代码更易读,可以自动生成文档,并将元数据嵌入到代码中。在深入学习PHP的反射特性的前提下,理解和应用这些文档规范尤为重要。 **1 编码规范** 编码...

    php生成文件类型

    在PHP中生成不同类型的文件是一项常见的任务,涵盖了多种文件格式,包括文本文件(txt)、HTML文档、CSV数据文件、PDF文档以及Microsoft Word的doc或docx格式。这些格式的生成通常涉及不同的库和方法,但核心思想是...

Global site tag (gtag.js) - Google Analytics