Question

我正在使用phpdoc.org中的工具，当我有一个PHP文件，例如header.inc.php，里面只有HTML时，我就陷入困境。

<?php
    /**
    * Header content
    *
    * @author  My name
    *
    * @since 1.0.0
    */
?>
<!DOCTYPE html>
<html lang="fr" class="no-js"> 
    <head>
...

我的phpdoc中出现错误“文件中找不到页面级DocBlock ...”。我用谷歌搜索了它，但我找不到任何用户的情况。

如何修复该错误？欢迎任何提示。

感谢的！

此致

Answer 1

我只是碰到了这个帖子，虽然它已经老了，但我想我会加两分钱。虽然sylouuu关于将命名空间直接放在您想要的页面级DocBlock之后是正确的，但我相信现在需要将'@package'标记放在DocBlock中。在处理逻辑与分层“包”时，需要注意一些事项。此行为基本上取决于您使用的PHPDocumentor版本。

来自：http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_elements.pkg.html “在phpDocumentor版本1.2.2中，页面级DocBlock是文件中第一个包含@package标签的DocBlock。”

在https://github.com/phpDocumentor/phpDocumentor2/issues/910，可以看到最近一个月前，没有PHP代码/节点的文件中的页面级DocBlocks问题仍然存在。因此，正如sylouuu所说的添加命名空间一样，一旦你这样做，你就有了一个可记录元素，你的问题应该得到解决。此外，由于很可能在没有节点存在的情况下不会创建页面的文档，因此这允许您的html-only文件创建其文档。

希望它有所帮助！ DW

Answer 2

Ok anwser发现：https://github.com/phpDocumentor/phpDocumentor2/issues/695

TL; DR：目前，它没有修复，只是忽略这些警告。

html包含文件中的phpDocumentor页面级docBlock

2 个答案: