【问题标题】:use phpDocumentor on symfony2在 symfony2 上使用 phpDocumentor
【发布时间】:2014-02-13 15:38:39
【问题描述】:

我安装了一个新的 symfony 2.4 项目,并按照以下步骤使用 composer.phar 安装了 phpDocumentor:

1- 添加: “需要开发”:{ “phpdocumentor/phpdocumentor”:“2.*” } 到我的 composer.json

2- 执行:php composer.phar 更新

安装终止后,我可以在 /vendor 中看到 phpdocumentor 文件夹,所以我猜安装已成功终止。

现在我想知道如何在 symfony 上使用 phpDocumentor(为我的代码源生成文档)。

我在 Ubuntu 网络服务器上工作。

谢谢你,对不起我的英语不好。

【问题讨论】:

  • 您阅读过有关此主题的documentation 吗?如果是,在运行php vendor/phpdocumentor/phpdocumentor/bin/phpdoc.php 时是否遇到任何错误?
  • 好的,这对我有帮助,谢谢您的回复。
  • @Touki 现在我可以使用 phpDocumentor 生成文档,我现在想知道的是,在 Symfony2 中存储文档的理想文件夹目的地是什么,以及如何使用始终使用 symfony 来可视化此文档
  • 如果您使用的是框架,您可以使用/web/docs 目录并通过//site.devel/docs 访问它,或者如果它是内部文档,您可以使用/docs。如果它是一个库,您可能需要使用/docs。如果是捆绑包,则占用/Resources/docs/

标签: php symfony ubuntu phpdoc


【解决方案1】:

步骤 1.phpdocumentor/phpdocumentor 的依赖项添加到项目的composer.json 配置文件的require-dev 部分,然后更新您的应用程序。

{
    "require-dev": {
        "phpdocumentor/phpdocumentor": "2.*"
    }
}

步骤 2. 在您的项目中运行 composer update 命令

STEP 3.CMD进入你项目的vendor\phpdocumentor\phpdocumentor\bin目录,然后运行以下命令生成AppBundle/Controller文件夹代码的文档。这将在\phpdocumentor\phpdocumentor\bin\doc 目标处生成您的AppBundle/Controller 文件夹的文档。

命令:- php phpdoc run -d ../../../../src/AppBundle/Controller/ -t doc/

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2013-04-06
    • 1970-01-01
    • 2013-12-29
    • 2012-05-07
    • 2012-09-18
    • 1970-01-01
    • 2021-11-10
    • 1970-01-01
    相关资源
    最近更新 更多