8.12. 创建类似wiki的文档

./script/solar make-docs Vendor [--lint] --package-dir=/path/to/package-output --class-dir=/path/to/class-output [--docbook-dir=/path/to/docbook-output]

这条命令将会检测SYSTEM/include/目录下Vendor工作区的所有类中的注释文档块。然后它为每个类产生类似wiki的文档文件,文件包含如下信息:类常量、类的配置信息、类的属性和方法。这些类似于wiki的文件可以被web应用处理并发布,或者你可以使用CLI脚本把它转化成其他格式。

产生的类文档将会存储在由选项--class-dir指定的目录,产生的包文档将会存储在由选项--package-dir指定的目录中。如果你传递了--docbook-dir选项,那么这些类似于wiki的文档会被转化为DocBook格式文件。然后你可以使用PHP Documentation Project PhD processor或其他DocBook处理器处理它们。

作为文档生成过程的一部分,当类中注释文档块不完整时,该命令将发出警告信息。如果你只想检查类中注释文档块的完整性而不生成任何文档,你可以给命令传递--lint选项。

解析器会识别由Solar_Docs_Phpdoc定义的一个JavaDoc/PhpDoc标签的子集。类中注释的标记规则由Solar_Markdown_Apidoc定义。要具体了解,请参考Solar的源代码。