我以前从未使用过 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 将所有文件放入了错误的位置。我已经尝试对它们进行整理以使其正常工作,但似乎无论我对输出文件进行多少重新排列,最终都需要进行更多的重新排列。此外,我不应该这样做。
我做错了什么?