phpdocで生成されたドキュメントと一緒に、高度なドキュメントをどのように維持しますか？私の最初のオープンソースプロジェクト（<a href="http://mtchart.googlecode.com" rel="nofollow noreferrer">shameless plug: mtChart</a>）については

Question

私は現在、ドキュメンテーションの二種類があります：コード内ではphpdoc-のコメントから、doxygenで生成

• HTMLファイルを
• Google Codeの上のwikiページを（あるいは、簡単に言えば：追加のテキストファイル）を

をDoxygenのファイルは、本当に素晴らしいですが、私は「ハイレベル」のドキュメントを追加する可能性について欠場：チュートリアル、例、システムに対する概要、ロードマップなど

どのようにこれらの2つを自動化して組み合わせると、コードド​​キュメントが何らかの形で自動的に残りのテキストも含めて更新されます。

（私は必要に応じて離れたDoxygenから移動するつもりです。）

Answer 1

あなたは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 
*/