Question

我之前从未使用过phpdoc，但我想要Authorize.Net PHP SDK文档，而且似乎我需要使用phpdoc生成它们。

当我跑步时：

C:\Users\Owner\PhpstormProjects\CRM\anet_php_sdk>C:\Users\Owner\wamp\bin\php\php5.3.13\phpdoc -t phpdocs/  -d lib

我得到了一个“解析文件”和“没有方法摘要”的流，我想这是好的。即使没有描述性摘要，对象方法和参数列表也足够了。

最终结果如下：

Storing cache in "C:\Users\Owner\PhpstormProjects\CRM\anet_php_sdk\phpdocs" .. O    K
Load cache                                                           ..    0.091    s
Preparing template "responsive-twig"                                 ..    0.168    s
Preparing 15 transformations                                         ..    0.000    s
Build "elements" index                                               ..    0.017    s
Replace textual FQCNs with object aliases                            ..    0.214    s
Build "packages" index                                               ..    0.025    s
Build "namespaces" index and add namespaces to "elements"            ..    0.006    s
Transform analyzed project into artifacts                            ..    6.702    s
Analyze results and write report to log                              ..    0.005    s

C:\Users\Owner\PhpstormProjects\CRM\anet_php_sdk>

我认为也没关系。

输出的目录结构如下所示：

 Directory of C:\Users\Owner\PhpstormProjects\CRM\anet_php_sdk\phpdocs

07/29/2013  03:20 PM    <DIR>          .
07/29/2013  03:20 PM    <DIR>          ..
07/29/2013  03:20 PM    <DIR>          classes
07/29/2013  03:20 PM            16,344 classes.svg
07/29/2013  03:20 PM    <DIR>          css
07/29/2013  03:20 PM             5,713 deprecated.html
07/29/2013  03:20 PM           100,054 errors.html
07/29/2013  03:20 PM             5,717 graph_class.html
07/29/2013  03:20 PM    <DIR>          img
07/29/2013  03:20 PM             7,528 index.html
07/29/2013  03:20 PM    <DIR>          js
07/29/2013  03:20 PM             6,900 markers.html
07/29/2013  03:20 PM    <DIR>          namespaces
07/29/2013  03:20 PM    <DIR>          packages
07/29/2013  03:20 PM    <DIR>          phpdoc-cache-08
07/29/2013  03:20 PM    <DIR>          phpdoc-cache-2b
07/29/2013  03:20 PM    <DIR>          phpdoc-cache-2e
07/29/2013  03:20 PM    <DIR>          phpdoc-cache-48
07/29/2013  03:20 PM    <DIR>          phpdoc-cache-4f
07/29/2013  03:20 PM    <DIR>          phpdoc-cache-62
07/29/2013  03:20 PM    <DIR>          phpdoc-cache-64
07/29/2013  03:20 PM    <DIR>          phpdoc-cache-7a
07/29/2013  03:20 PM    <DIR>          phpdoc-cache-8c
07/29/2013  03:20 PM    <DIR>          phpdoc-cache-a3
07/29/2013  03:20 PM    <DIR>          phpdoc-cache-a6
07/29/2013  03:20 PM    <DIR>          phpdoc-cache-db
07/29/2013  03:20 PM    <DIR>          phpdoc-cache-e0
               6 File(s)        142,256 bytes
              21 Dir(s)  394,722,947,072 bytes free

C:\Users\Owner\PhpstormProjects\CRM\anet_php_sdk\phpdocs>

看起来有点奇怪，一堆缓存正在四处，但不管怎样，我不知道对phpdoc有什么期待。

但是 - 实际的文档无法使用。索引是非常漂亮和绿色等，但索引的每个链接都会将我带到一个未格式化的屏幕，我强烈怀疑缺少CSS格式。

来自任何这些页面的每个链接（例如查看方法）都很糟糕。似乎phpdoc将所有文件放入错误的位置。我已经尝试将它们排序以使其工作但似乎无论重新排列输出的文件我最终需要更多的重新排列。此外，我不需要这样做。

我做错了什么？

Answer 1

好吧，我只需要手动重新安排所有的phpdoc输出。相当邋恕恕我直言。

Answer 2

response-twig模板有一个错误我建议您尝试使用new-black

这样的模板

phpdoc --template=new-black -t phpdocs/ -d lib

来源：Issue954

phpdoc生成具有损坏的链接和格式的文档

2 个答案: