PHPDocumentor模板

Question

有人可以告诉我：

1. 在何处下载新模板
2. 如何安装模板以覆盖默认值。
3. 默认模板文件夹在哪里？

THK。

Answer 1

- phpdoc cmd行中的模板或编辑/usr/share/pear/phpDocumentor/data/templates/phpdoc.tpl.xml并更改“使用模板名称作为默认值的行”。

默认模板目录是usr / share / pear / phpDocumentor / data / templates

Answer 2

我下载了phpDocumentor.phar，对可用的模板也有些困惑。这来自source on github

• abstract
• checkstyle
• 清洁
• new-black
• old-ocean
• responsive-twig
• 响应
• xml
• zend

Answer 3

  

在哪里下载新模板

没有为此的“官方”页面；您必须在互联网上搜索。

但是，如果您想尝试VuePress，则可以使用我创建的兼容模板nelson6e65/phpdoc-vuepress（see a demo）。

---

  

如何安装模板以覆盖默认值

安装模板的方法有很多：手动下载，使用Composer等...

重要的是，在 中安装了“新”模板，然后，如所述in documentation所示，您可以通过向---template传递以下位置来使用外部模板：您的模板（template.xml所在的目录）：

$ phpdoc -d "./src" -t "./docs/api" --template="data/templates/my_template"

例如，对于template I linked before，您可以通过运行以下命令来实现：

# Installing
$ composer require --dev nelson6e65/phpdoc-vuepress
# Using
$ phpdoc -d=src/ -t=docs/api/ --template="vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress"

在这种情况下，此template.xml文件安装在项目的相对路径中：vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress/template.xml

  

注意： ：如果我使用*.phar，则在使用自定义模板时会遇到错误。因此，您可能需要使用phpdoc的另一种分发方法。

---

  

默认模板文件夹在哪里

取决于您的安装方法。

如果您使用Composer安装或下载了源代码，则template文件夹是相对于data/templates的安装位置的。对于Composer，位于：

vendor/phpdocumentor/phpdocumentor/data/templates/

  

对于通过composer进行全局安装，模板位于广告~/.config/composer/vendor/phpdocumentor/phpdocumentor/data/templates

---

我希望这对您和其他人有用。问候！ ：）