README

概览

Documen可以从任何PHP docblock（包括其中的标记）生成html文档。您可以将它配置为读取全局函数、类或整个文件的docblock。

使用composer安装

"require": {
  "jimgitsit/documen": "dev-master"
}

用法在您的PHP应用的根目录下创建一个名为documen.json的文件。在这里，您将定义想要生成文档的文件、类、方法和函数。以下是一个documen.json文件的示例：

{
  "output-dir": "/app/views/docs" <required, html output directory (relative to the vendor parent dir)>
  "css-file": "/public/css/document.css" <optional, custom css file>
  "classes": ["MyFancyClass"],
  "methods": [
    {
      "class": "MyFancyClass",
      "method": "fancyMethod"
    }
  ],
  "files": ["my-fancy-class.php"],
  "function": ["some_global_func"]
}

在项目根目录的终端中运行

php vendor/jimgitsit/documen/documen.php generate-docs

jimgitsit / documen

维护者

详细信息

README