phpdocumentor 学习笔记（二）

这里放上phpdocumentor的命令操作。

-c, --config
用于加载配置文件

-cp, --converterparams
用于传递扩展转换器的动态参数，选项以逗号分隔

-ct, --customtags
自定义标签选项，选项以逗号分隔

-dh, --hidden
使用此选项用于屏蔽分析以.开头的文件

-dc, --defaultcategoryname
用于设置任何未分类的文件的默认分类

-dn, --defaultpackagename
用于设置任何未定义包名称的默认包名称

-d, --directory
这个选项或者-f选项必须要制定，如果使用-d，则会递归的分析指定的目录下以.php结尾的文件

-ed, --examplesdir
指定实例文件夹

-f, --filename
这个选项或者-d必须指定一个，如果使用-f，会分析单个文件

-i, --ignore
设置需要忽略的文件或者目录

-is, --ignoresymlinks
设定忽略符号链接

-it, --ignore-tags
设定忽略标签

-j, --javadocdesc
设定解析时兼容javadoc格式

-o, --output
设置输出文件的格式
      HTML:frames:* - 包含iframe的HTML格式
      HTML:frames:default – Javadoc风格的文档模板，很少有格式
      HTML:frames:earthli – 漂亮的模板（作者：Marco von Ballmoos）
      HTML:frames:l0l33t – 流行模板
      HTML:frames:phpdoc.de – 类似于phpdoc.de的PHPDoc输出
      HTML:frames:phphtmllib – 非常棒的用户贡献模板
      HTML:frames:phpedit – 基于PHPEdit Help Generator的文档
      HTML:Smarty:* - 不使用iframe的HTML格式
      HTML:Smarty:default – 使用css控制的黑体模板
      HTML:Smarty:HandS – 基于PHP的格式，但是经过优化，带有logo图片
      HTML:Smarty:PHP – 风格接近PHP官网
      CHM:default:* - 输出CHM帮助文档
      CHM:default:default – windows帮助文档，基于HTML:frames:l0l33t
      PDF:default:* - PDF格式
      PDF:default:default – 标准纯文本PDF格式
      XML:DocBook:* - 以DocBook格式输出的XML
      XML:DocBook/peardoc2:default – 可以被编译成peardoc的文档

-pp, --parseprivate
默认情况下，phpDocumentor不会把标记为@access private纳入文档，使用此选项可以将其纳入

-po, --packageoutput
使用此选项会将输出文档中以@package分组的标记（逗号分隔）删除

-p, --pear
使用此选项可以解析pear风格的文档

-q, --quiet
此选项将压缩命令行的输出

-s, --sourcecode
使用此选项会为每一个被解析的文件生成高亮代码，谨慎使用

-t, --target
目标路径，设定输出文档的目录

-tb, --templatebase
接受一个路径作为它的参数，设置文档模板的路径，不指定情况下为<phpDocumentor install directory>/phpDocumentor，phpDocument会在此路径的子文件夹下搜索可用的模板

-ti, --title
生成的文档的标题

-ue, --undocumentedelements
这个选项用于设置在遇到没有docblock标记的class或者method时，是否输出warning信息