如何维护高级文档以及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生成的文档？

回答

相关问题