【问题标题】:Where should I place the phpdoc.xml file?我应该将 phpdoc.xml 文件放在哪里?
【发布时间】:2013-12-12 04:29:49
【问题描述】:

phpdoc 可以使用 .xml 文件或 .ini 文件进行配置。文档模棱两可,但似乎使用 .xml 文件是目前的首选方法。同意吗?

我应该将 .xml 文件放在哪里?

根据http://www.phpdoc.org/docs/latest/for-users/configuration.html...

最简单的解决方案是将配置文件放在 项目的根目录,名称为:phpdoc.dist.xml。

他们将哪个目录称为“项目的根目录”?我已经尝试了一切,即

/usr/share/pear/phpDocumentor, 
/var/www/phpDocumentor,
 /var/www,

似乎没有任何效果。

【问题讨论】:

  • 你有没有得到这个排序?我似乎有同样的问题。你在使用 phar 文件吗?

标签: php phpdoc


【解决方案1】:

项目的根目录是放置生成文档所需的代码的位置。示例:您需要为/var/www/example 目录中的代码生成文档,然后生成 phpdoc.dist.xml。应该在里面。它就像composerphpunit 一样工作。

再举例:

$ phpdoc -d ./src -t ./docs/api

phpdoc.dist.xml 应该位于./src

【讨论】:

  • 谢谢egig。那么,在运行 phpdoc 时,我是否也需要在同一个目录中?否则,phpdoc 怎么知道要使用哪个 phpdoc.dist.xml?另外,如果我想解析 /var/www/thisDir 和 /var/www/thatDir,我是不是把它放在 /var/www 中?
  • do I also need to be in that same directory? 否,但您必须指定 -d /your/src/path 选项。 how do phpdoc know which phpdoc.dist.xml to use ? 存在于 /your/src/path 中的那个。 do I put it in /var/www? ... $ phpdoc -d /var/www/thisDir -t /var/www$ phpdoc -d /var/www/thatDir -t /var/www
  • 但是phpdoc.org/docs/latest/for-users/configuration.html 声明您不需要通过phpdoc 输入任何内容,因为所有必要的信息都在xml 文件中。
  • 是的,只有When you have added a configuration file。我的意思是do I also need to be in that same directory? 并非总是如此。如果您在配置文件中定义了路径,则不需要-d 选项。
  • 我还没有让这个工作。但我使用的是自定义 phar 文件。这会影响什么吗?
猜你喜欢
  • 2010-12-01
  • 2018-09-28
  • 2019-10-04
  • 1970-01-01
  • 2013-09-22
  • 2016-05-23
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多