phpDocumentor頁面級docBlock在HTML包括的文件

我使用phpdoc.org的工具，當我有一個PHP文件，如header.inc.php只有HTML裏面，我卡住了。phpDocumentor頁面級docBlock在HTML包括的文件

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

我得到了我的PHPDoc的錯誤「沒有頁面級文檔塊在文件中找到的......」。我GOOGLE了，但我沒有找到任何用戶與我的情況。

如何解決該錯誤？任何提示都歡迎。

謝謝！

問候

來源

2012-11-29 Syl

好anwser發現：https://github.com/phpDocumentor/phpDocumentor2/issues/695

TL; DR：目前，它不是固定的，忽略論文警告。

來源

2012-12-06 09:41:19 Syl

提示發現，放置一個命名空間如：namespace ns; – Syl

你是怎麼做到的？你能給個例子嗎？以及文檔中的頁面級docblock將如何顯示？ –

我只是碰到了這個帖子，雖然年齡較大，但我還是想補充兩分錢。雖然sylouuu將正確的名稱空間放置在您想要的頁面級別的DocBlock之後是正確的，但我相信現在需要將'@package'標記放在DocBlock中。在處理邏輯與分層「包」時，這裏有一些警告。此行爲基本上取決於您正在使用的PHPDocumentor的版本。

From：http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_elements.pkg.html 「在phpDocumentor 1.2.2版中，如果文件包含@package標記，則頁級別DocBlock是文件中的第一個DocBlock。」

而在https://github.com/phpDocumentor/phpDocumentor2/issues/910可以看出，就在最近一個月前，在沒有PHP代碼/節點的文件中頁面級別的DocBlocks問題仍然在起作用。因此，正如sylouuu所說的添加命名空間一樣，一旦你這樣做了，你就有了一個可以記錄的元素，你的問題應該得到解決。此外，由於很可能沒有存在節點就不會創建頁面的文檔，這允許您的僅限html文件創建文檔。

希望它能幫助！ dw

來源

2013-08-08 01:11:07 user2662730

phpDocumentor頁面級docBlock在HTML包括的文件

回答

相關問題