如何維護高級文檔以及phpdoc生成的文檔？

對於我的第一個開源項目（shameless plug: mtChart）我現在有兩種不同類型的單證的：通過使用Doxygen從PHPDoc的-註釋代碼內產生如何維護高級文檔以及phpdoc生成的文檔？

HTML文件
在谷歌代碼維基頁面（或簡單地說：其他的文本文件）

doxygen的文件確實是偉大的，但我錯過了方法可行添加「高層次」的文檔：教程，範例，概述了該系統，路線圖等

如何以自動方式將這兩者結合起來，以便我可以自動更新代碼文檔，並自動包含其餘文本？

（我願意在必要時從Doxygen的移開。）

來源

2009-08-20 Christian Studer

您是否在討論如何使用代碼中的註釋類生成教程？如果是這樣，這聽起來像一個很酷和有趣的項目。你甚至可以推斷各種事情。聽起來很酷。 – 2009-08-25 06:23:13

是的，沒有。我不想生成教程，我已經寫了一些，並希望將它們與文檔自動結合起來... – 2009-08-25 12:04:17

結合它們如何？ – 2009-08-26 02:03:30

如果使用PHPDoc的風格你明明知道你能做的例子，教程等右裏面，並提供鏈接到外部內容像路線圖那樣必要。這並不理想，但絕對有效，併爲您提供一致和有用的文檔。只需在您的評論中使用一些格式，便於閱讀文本並@查看鏈接。你也可以考慮使用內聯標籤，但我不確定你需要從頭開始。

/** 
* @todo Need to move to the main framework 
* 
*  class: RegistrationPeer extends AbstractPeer 
*  package: Registration 
* subpackage: Peer 
* 
*  method: findByUserId($userId) 
* visibility: public 
*  static: yes 
* 
*   file: xxx 
* 
*  class: Registration extends AbstractModel 
*  package: Registration 
* subpackage: Model 
* 
* Sample usage: 
* <code> 
* <?php 
*  $userId = $sessionManager->getRegUid(); 
*  $registration = RegistrationPeer::findByUserId($userId); 
* ?> 
* </code> 
* 
* @see AbstractPeer 
* @see http://docs.google.com/Doc?docid=xxxx&hl=en 
* 
* @author xxx 
*/

來源

2009-08-26 09:42:25

感謝您的信息，我並沒有真正意識到所有的phpdoc可能性。猜猜我會再次擊中文檔... :-) – 2009-08-31 08:13:11

如何維護高級文檔以及phpdoc生成的文檔？

回答

相關問題