PhpDoc';s生成的文档不';不能连在一起
我试图对Magento进行反向工程,我认为阅读每一种方法都是一个好的开始(官方文档太肤浅)。Magento似乎没有预生成的文档,这是公平的,因为每种配置都不同于其他配置,并且一般地对其进行文档记录是没有意义的。代码库中有docblock,我想我可以使用PhpDoc为它生成文档 设置 Magento发行版为2.3.3,取自其github页面: 该环境位于Docker Ubuntu容器中,版本为18.04.3 LTS。以下是Dockerfile中的重要部分:PhpDoc';s生成的文档不';不能连在一起,php,magento2,phpdoc,Php,Magento2,Phpdoc,我试图对Magento进行反向工程,我认为阅读每一种方法都是一个好的开始(官方文档太肤浅)。Magento似乎没有预生成的文档,这是公平的,因为每种配置都不同于其他配置,并且一般地对其进行文档记录是没有意义的。代码库中有docblock,我想我可以使用PhpDoc为它生成文档 设置 Magento发行版为2.3.3,取自其github页面: 该环境位于Docker Ubuntu容器中,版本为18.04.3 LTS。以下是Dockerfile中的重要部分: RUN apt-get -y insta
RUN apt-get -y install php-bcmath \
php-curl \
php-gd \
php-intl \
php-soap \
php-zip \
php-mbstring \
#php-dom \
php-xml \
php-mysql \
composer
RUN mkdir /phpdoc \
&& wget -O /phpdoc.tar.gz https://github.com/phpDocumentor/phpDocumentor/archive/v3.0.0-alpha.4.tar.gz \
&& tar -xvpzf /phpdoc.tar.gz -C /phpdoc --strip-component=1 \
&& cd /phpdoc \
&& composer install
RUN echo "\nexport PATH=$PATH:/var/www/magento/bin:/phpdoc/bin\n" >> /root/.bashrc
第一次运行是安装Magento的依赖项
第二次运行是在/phpdoc安装phpdoc
第三次运行是使phpdoc命令全局化
Php版本是7.3.12
我必须使用phpdoc版本3,因为php版本是7。我尝试在PhpDoc版本2上运行完全相同的设置,但它不起作用。我四处寻找解决方案,一致认为PhpDoc无法解析PHP7,所以我必须使用版本3
PhpDoc似乎安装良好。它似乎运行得也很好。我试着在一个小文件夹上运行它(位于/var/www/magento/app/code/magento/Tax
,其中/var/www/magento
是文档根目录)来测试一下
shell输出:
root@78ace9205c9e:/var/www/magento/app/code/Magento# phpdoc -d Tax -t /var/www/docs
phpDocumentor vNo version set (parsed as 1.0.0)@
Parsing files
Applying transformations (can take a while)
17/17 [============================] 100%
All done!
root@78ace9205c9e:/var/www/magento/app/code/Magento#
这些文件也整齐地放在/var/www/docs中,看起来很正常。这是目录列表:
root@78ace9205c9e:/var/www/docs# ls -la
total 472
drwxr-xr-x 11 root root 4096 Dec 10 16:20 .
drwxr-xr-x 1 root root 4096 Dec 10 17:05 ..
-rw-r--r-- 1 root root 229 Dec 10 19:09 .htaccess
drwxr-xr-x 2 root root 90112 Dec 10 18:56 classes
drwxr-xr-x 3 root root 4096 Dec 10 16:20 css
drwxr-xr-x 70 root root 94208 Dec 10 18:56 files
drwxr-xr-x 2 root root 4096 Dec 10 16:20 font
drwxr-xr-x 2 root root 4096 Dec 10 16:20 graphs
drwxr-xr-x 3 root root 4096 Dec 10 16:20 images
-rw-r--r-- 1 root root 202668 Dec 10 19:09 index.html
drwxr-xr-x 3 root root 4096 Dec 10 16:20 js
drwxr-xr-x 2 root root 49152 Dec 10 18:55 namespaces
drwxr-xr-x 2 root root 4096 Dec 10 16:20 reports
root@78ace9205c9e:/var/www/docs#
问题
这是/var/www/docs/index.html文件的一部分:
root@78ace9205c9e:/var/www/docs# cat /var/www/docs/index.html | head -n 219 | tail -n 36
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-306007264"></a>
<a href="" style="margin-left: 30px; padding-left: 0">Block</a>
</div>
<div id="namespace-306007264" class="accordion-body collapse ">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-954821111"></a>
<a href="" style="margin-left: 30px; padding-left: 0">Adminhtml</a>
</div>
<div id="namespace-954821111" class="accordion-body collapse ">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-289993205"></a>
<a href="" style="margin-left: 30px; padding-left: 0">Frontend</a>
</div>
<div id="namespace-289993205" class="accordion-body collapse ">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1022188315"></a>
<a href="" style="margin-left: 30px; padding-left: 0">Region</a>
</div>
<div id="namespace-1022188315" class="accordion-body collapse ">
<div class="accordion-inner">
root@78ace9205c9e:/var/www/docs#
root@78ace9205c9e:/var/www/docs#cat/var/www/docs/index.html | head-n 219 | tail-n 36
root@78ace9205c9e:/var/www/docs#
如果您仔细注意,链接的HREF是空的。这基本上意味着这些文件几乎一文不值。这是视觉上的结果:
左边的菜单看起来不错,我可以浏览树结构。但当我单击1个菜单项时,它只返回默认页面(这是预期的,因为HREF是空的)。如果直接转到名称空间的html文件,如/namespaces/Magento.Tax.html,它工作正常,如下所示:
一切似乎都很好,但神秘的链接就是不起作用。感谢您的帮助 所以在尝试其他php文档工具一段时间后,它们都不能正常工作。我想这是因为php7是如此的新,以至于几乎还没有人能让它工作。我的解决方案是在phpstorm中打开每个文件,让它为所有内容建立索引,并将其用作临时文档