我以前从未使用过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
我得到了一个"解析文件"answers"方法没有摘要"的流,我认为这是可以的。即使没有描述性摘要,对象方法和参数的列表也足够了。
结果是:
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似乎把所有文件都放错了地方。我尝试过对它们进行排序以使其工作,但似乎无论我对输出的文件进行多少重新排列,最终都需要进行更多的重新排列。此外,我不应该这么做。
我做错了什么?
响应树枝模板有一个错误
我建议你试试new-black
这样的模板
phpdoc --template=new-black -t phpdocs/ -d lib
来源:Issue954
我只需要手动重新安排所有phpdoc输出。相当草率的IMHO。