PHP文档生成器（PHPDoc）的基本用法

2024-04-23 08:49:16

目录

PHP文档生成器（PHPDoc）的基本用法
PHPDoc概述
安装
PHPDoc注释规范
- 页面级别的注释
- 代码级别的注释
生成API文档
额外软件

PHP文档生成器（PHPDoc）的基本用法

PHPDoc概述

PHPDoc是一种注释PHP代码的正式标准，一般是通过外部文档生成器phpDocumentor生成API文档。同事支持面向过程和面向对象的代码风格，而且很多高级IDE如PHPStorm对其有很好的支持。灵活使用PHPDoc生成API文档可以有效提高开发效率，本文主要是记录PHPDoc的基本用法。

安装

PHPDoc官方提供三种安装方式，分别是通过pear、composer和phar进行安装。Linux通过pear安装phpdoc比较简单，只需按照官方引导即可。composer主要针对项目，需要注意的是composer安装phpdoc会引入很多依赖包。phar方式需要下载phpDocumentor外部文档，然后在终端通过php-cli进行调用即可。本文采用了第三种方法，这种方法可以兼容各操作系统，并且不需要安装额外软件。

PHPDoc注释规范

页面级别的注释

一般来说，页面级的文档块就是文件中出现的第一个文档块，推荐使用@package标签对文件路径进行标注。

代码级别的注释

代码级别主要指类、变量和方法的注释块，其中方法的参数值和返回值注释与PHP的数据类型基本相同。需要注意PHPDoc不支持对单行注释的解析，所以需要使用代码块。

生成API文档

php phpDocumentor.phar -d Pro/ -t docs/api

-d后面跟文件夹路径，如果是单个文件，可以用-f。-t表示目标target，后面跟API文档生成的文件夹。如果需要指定模板，可以在代码后面追加--template。

php phpDocumentor.phar -d Pro/ -t docs/api --template="clean"

可以通过template:list查看所支持的内置模板

php phpDocumentor.phar template:list

可以直接在template后面接自定义模板

php phpDocumentor.phar -d Pro/ -t docs/api --template="data/template/my_template"

额外软件

如果需要查看类的图表，需要安装Graphviz。以ubuntu为例

sudo apt-get install graphviz

转载于:https://www.cnblogs.com/libera/p/10518861.html

PHP文档生成器（PHPDoc）的基本用法相关推荐

JSDoc --JS API文档生成器
JSDoc 是一个JavaScript的API文档生成器. 他可以让开发者在开发的过程中, 将编写的注释通过JSDoc工具生成一个api文档, 妈妈再也不用担心我不会写接口文档了. 这里是原作者Git ...
Sandcastle帮助文档生成器使用介绍
一.软件介绍 Sandcastle是一个管理类库的文档编译器,是用于编译发布组件(Assembly)信息的一个工具,这个工具通过反射和 Xslt技术,可以从dll文件及其xml注释(命令行编译时加/d ...
Jazzy 文档生成器使用
Jazzy 文档生成器使用 Jazzy 简介 jazzy 是一个命令行实用程序,可以为 Swift 或者 Objective-C 生成文档,输出风格和官方文档匹配(也可以自定义模板) 如果是 Swif ...
simple css 汉化,Simple CSS(CSS文档生成器)
Simple CSS(CSS文档生成器)简介 Simple CSS(CSS文档生成器)简介一:Simple CSS是一款CSS文档生成器,帮助网页开发人员快速生成CSS样式,Simple CSS使用非 ...
开源数据库表结构文档生成器
大家好,我是TJ 一个励志推荐10000款开源项目与工具的程序员 TJ君前几天和一个在银行科技部上班的同学聚会,同学跟TJ君吐槽,一些小银行的科技表面看上去专业,实际各种马虎不负责. 打个比方,有一次 ...
python文档生成工具_pydoc --- 文档生成器和在线帮助系统 — Python 3.9.1rc1 文档
pydoc --- 文档生成器和在线帮助系统¶ The pydoc module automatically generates documentation from Python modules. ...
django 1.8 官方文档翻译：7-3 Django管理文档生成器
Django管理文档生成器 Django的admindocs应用从模型.视图.模板标签以及模板过滤器中,为任何INSTALLED_APPS中的应用获取文档.并且让文档可以在Django admin中使 ...
发布CHM文档生成器可替代 HTML Help Workshop，有全部C#源代码
CHM文档生成器现在的程序很多配备CHM格式的帮助文件,一般的开发者使用 HTML Help Workshop 来定义CHM文档,但操作不甚方便,而CHM文档生成器就可用来很方便的编辑CHM文档结构 ...
python 文档生成_文档生成器 mkdocs
mkdocs 是 Python 一个对 Markdown 非常友好的文档生成器,中文文档地址使用 mkdocs 我们可以用md 编写自己的文档,而且可以免费部署到 GitHub . 安装 pip i ...

最新文章

热门文章