Documentation 如何维护高级文档以及phpdoc生成的文档？
对于我的第一个开源项目（），我目前有两种不同类型的文档：Documentation 如何维护高级文档以及phpdoc生成的文档？,documentation,phpdoc,Documentation,Phpdoc,对于我的第一个开源项目（），我目前有两种不同类型的文档： Doxygen从代码中的phpdoc注释生成的HTML文件 谷歌代码上的维基页面（或者简单地说：附加文本文件） Doxygen文件确实很棒，但我不太可能添加“高级”文档：教程、示例、系统概述、路线图等 如何以自动化的方式将这两者结合起来，使代码文档能够以某种方式自动更新，包括其余的文本 （如有必要，我愿意离开Doxygen。）如果您使用phpdoc样式，您显然知道您可以在其内部制作示例、教程等，并根据需要提供指向外部内容（如路线图）的
- Doxygen从代码中的phpdoc注释生成的HTML文件
- 谷歌代码上的维基页面（或者简单地说：附加文本文件）
（如有必要，我愿意离开Doxygen。）如果您使用phpdoc样式，您显然知道您可以在其内部制作示例、教程等，并根据需要提供指向外部内容（如路线图）的链接。 它并不理想，但确实有效，为您提供了一致且有用的文档。只需在你的评论中使用一些格式，以便于阅读文本，并在链接中使用@see。 您也可以考虑使用内联标签，但我不确定从一开始就需要这么做。
/**
* @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
*/
/**
*@todo需要移动到主框架
*
*类：RegistrationPeer扩展AbstractPeer
*套餐：注册
*子包：对等
*
*方法：findByUserId（$userId）
*能见度：公众
*静态：是的
*
*档案：xxx
*
*类：注册扩展抽象模型
*套餐：注册
*子包：模型
*
*示例用法：
*
*
*
*
*@见AbstractPeer
*@见http://docs.google.com/Doc?docid=xxxx&hl=en
*
*@author xxx
*/