欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  后端开发

ApiGen4.1 windows安装教程,apigen4.1教程_PHP教程

程序员文章站 2022-05-06 14:24:31
...

ApiGen4.1 windows安装教程,apigen4.1教程

一. ApiGen4.1版本介绍

1.ApiGen介绍

ApiGen4.1 windows安装教程,apigen4.1教程_PHP教程

ApiGen是自动生成PHP项目的阅读文档工具。 用于从PHP源代码创建专业的API文档,类似于phpDocumentor/phpDoc。

ApiGen4.1需要PHP 5.4+的版本支持

2.ApiGen官网地址

(1).OSCHINA地址www.oschina.net/p/apigen

(2).官网地址www.apigen.org

(3).github地址https://github.com/apigen/apigen#options

3.知名案例:

4.ApiGen风格样式

官方推荐有默认和Twitter Bootstrap两套风格样式。

  • ApiGen官方默认风格
  • ApiGen4.1 windows安装教程,apigen4.1教程_PHP教程
  • ApiGen官方Bootstrap风格
  • ApiGen4.1 windows安装教程,apigen4.1教程_PHP教程

二.ApiGen windows安装步骤

1. 下载ApiGen。

官网地址http://www.apigen.org/

官网下载地址http://apigen.org/apigen.phar

2.编写windows可执行bat文件

打开记事本写入以下相关信息,并另存为apigen.bat文件。

> @(PHP.exe执行文件地址) "%~dp0apigen.phar" %*

例如

@D:\xampp\php\php.exe "%~dp0apigen.phar" %*

另存为apigen.bat

3.将apigen.phar及apigen.bat文件复制或移动到环境变量PATH任一目录中。

windows7 对应目录为 C:\Windows\System32

4.在命令行中执行apigen出现版本及相关命令信息则证明安装成功。

c:\>apigen
ApiGen version 4.1.0

Usage:
 command [options] [arguments]

Options:
 --help (-h)    Display this help message.
 --quiet (-q)   Do not output any message.
 --version (-V) Display this application version.

Available commands:
 generate      Generate API documentation
 help          Displays help for a command
 list          Lists commands
 self-update   Updates apigen.phar to the latest available version
 selfupdate    Updates apigen.phar to the latest available version

5.执行生成apigen文档命令。

apigen generate --source "php项目地址" --destination "文档导出地址"

完整示例

apigen generate --source "D:\web\ruionline" --destination "D:\web\ruionline\doc"

导出生成过程

ApiGen4.1 windows安装教程,apigen4.1教程_PHP教程

最终生成目录结构

ApiGen4.1 windows安装教程,apigen4.1教程_PHP教程

web展示效果

ApiGen4.1 windows安装教程,apigen4.1教程_PHP教程

三.apigen命令参数详细说明
--source 需要编译成文档的 Project 目录, --source  同时可以指定多个
--destination   编译后存放的目录路径
--title   文档首页的标题
--exclude  排除的目录(如 'views/*' 表示视图目录下的不生成文档)

Options:
 --source (-s)        Dirs or files documentation is generated for. (multiple va
lues allowed)
 --destination (-d)   Target dir for documentation.
 --access-levels      Access levels of included method and properties. (default:
 ["public","protected"]) (multiple values allowed)
 --annotation-groups  Generate page with elements with specific annotation.
 --base-url           Base url used for sitemap (useful for public doc).
 --config             Custom path to apigen.neon config file. (default: "E:\\ide
/apigen.neon")
 --google-cse-id      Custom google search engine id (for search box).
 --google-analytics   Google Analytics tracking code.
 --debug              Turn on debug mode.
 --deprecated         Generate documentation for elements marked as @deprecated
 --download           Add link to ZIP archive of documentation.
 --extensions         Scanned file extensions. (default: ["php"]) (multiple valu
es allowed)
 --exclude            Directories and files matching this mask will not be parse
d (e.g. */tests/*). (multiple values allowed)
 --groups             The way elements are grouped in menu. (default: "auto")
 --charset            Charset of scanned files. (multiple values allowed)
 --main               Elements with this name prefix will be first in tree.
 --internal           Include elements marked as @internal.
 --php                Generate documentation for PHP internal classes.
 --skip-doc-path      Files matching this mask will be included in class tree, b
ut will not create a link to their documentation. (multiple values allowed)
 --no-source-code     Do not generate highlighted source code for elements.
 --template-theme     ApiGen template theme name. (default: "default")
 --template-config    Your own template config, has higher priority templateThem
e.
 --title              Title of generated documentation.
 --todo               Generate documentation for elements marked as @todo.
 --tree               Generate tree view of classes, interfaces, traits and exce
ptions.
 --help (-h)          Display this help message.
 --quiet (-q)         Do not output any message.
 --version (-V)       Display this application version.

四.apigen支持php注释详解

支持官方PSR-5标准

1.Custom

@deprecated
package
subpackage
copyright
license
author
version
since
see
uses
internal
todo
Standard

2.param

return
throws
{@inheritdoc}
Magic methods and properties

3.property

property-read
property-write
method

www.bkjia.comtruehttp://www.bkjia.com/PHPjc/1059467.htmlTechArticleApiGen4.1 windows安装教程,apigen4.1教程 一. ApiGen4.1版本介绍 1.ApiGen介绍 ApiGen是自动生成PHP项目的阅读文档工具。 用于从PHP源代码创建专业的...
相关标签: windows