参数说明¶

FizeDoc 命令支持参数如下：

config (短参数c) 指定配置文件

dir (短参数d) 指定源代码目录

file (短参数f) 指定源代码文件

handler (短参数h) 指定编译处理器

namespace (短参数n) 指定源代码顶层命名空间

output (短参数o) 指定文档输出位置

FzieDoc 配置文件除支持除 config 以外的以上参数，还支持如下参数：

filters 指定过滤器

map 指定源代码文件夹在文档中的命名规则

FzieDoc 配置文件原生支持 PHP 语言，您可以在里面任意使用 PHP 代码。

注解

配置文件的定义会被命令行参数覆盖。

config¶

config 参数指定配置文件，默认为当前目录下的 fizedoc.php 文件，如果存在该文件则自动载入，不存在则载入默认参数配置。

dir 参数指定源代码目录。

file 参数用于指定指定源代码文件。针对指定多个文件的情况：使用命令行参数形式时，以英文字符逗号“,”隔开；在配置文件里，则以数组形式进行定义。

handler 参数用于指定编译处理器。目前可选的编译处理器有：

ReStructuredText (简写 rst) : 输出 ReStructuredText 格式文档

Markdown (简写 md) : 输出 Markdown 格式文档

警告

Markdown 在 v0.0.1 版本尚未实现，请暂时勿使用。

namespace 参数用于指定源代码顶层命名空间。只有正确指定了命名空间，才能进行源代码分析，否则将出现错误。对于未使用命名空间的源代码，可以不指定该参数，默认为空。

output 参数用于指定文档输出位置。

对于 file 类型的代码解析，output 参数对应为文档输出文件路径，多个文件请顺序一一对应。指定多个文件的情况：使用命令行参数形式时，以英文字符逗号“,”隔开；在配置文件里，则以数组形式进行定义。

对于 dir 类型的代码解析，output 参数对应为文档输出根目录路径，默认为当前目录下的 output 文件夹。

filters 参数用于指定过滤器。

通过指定过滤器，可以指定要输出的类、常量、属性、方法。

filters 参数为数组类型，可用键名如下：

class:	用于过滤类。

constant:	用于过滤类常量。

参数名	说明	可选值	默认值
scope	指定作用域	[‘public’, ‘protected’, ‘private’]	[‘public’]

function:	用于过滤函数。

method:	用于过滤方法。

property:	用于过滤属性。

map 参数用于指定源代码文件夹在文档中的命名规则。

map 参数是一个数组。从源代码文件夹顶层开始进行定义。下标 0 用于定义文件夹所对应的文档名称，下标 1 作为可选值用于定义子菜单。子菜单定义键名为文件夹名称，值的定义和 map 顶层定义一致。

'map' => [
        '类库参考',
        [
                'driver'  => ['驱动'],
                'handler' => ['处理器']
        ]
]