基于PHP的手动应用程序

Question

是否有用于编写tehcnical/API类型手册的精心制作的Web应用程序？我有一些代码，我想写一些“入门”指南，也许还有一些参考内容。

PHPDocumentor对于记录我的类的层次结构来说都很好，但我也希望把这些东西放在一起，这样可以让人看起来更具有可读性和线性。我想一般的CMS可以正常工作，或者只是从头开始构建。但是，如果有任何设计专门用于编写在线手册，我想知道更多。

Answer 1

DocBook将是写手册的方法之一，但我不知道任何CMS。我已经分享了它在PEAR上的工作，到目前为止，我一直使用普通的文本编辑器编写/编辑页面。我想，从头开始是更难。

如果您需要某些东西更多直观，请尝试dokuwiki。它非常小巧轻便，而且很有效。

另外，请记住，phpdoc允许您嵌入代码示例等，因此也许可以查看该示例（例如：inline {@example}）。

Answer 2

大多数他们的文档写入类似维基的服务。谷歌代码有一个，或者你可以自己安装，比如MediaWiki或Trac。

Answer 3

我不知道它是否会为你做这项工作，但通过www.php.net在线提供的整个PHP手册是一个开源应用程序。

不知道它的内部，但从用户POV看起来足够好。

Answer 4

我发现这些链接前一阵子....

http://www.winnershtriangle.com/w/Products.PHPDocumentationTool.asp

http://doc.php.net/php/dochowto/

享受...

Answer 5

restructured text是在Python社区的热门选择。