为REST API生成DOC [关闭]

Question

我已经生成了我的REST API，现在我必须编写API的文档。

由于API主要由第三方插件生成，因此无法自动生成DOC。

那么手动编写DOC的最佳工具（节省时间）是什么？

PS：我确实有github帐户，我想知道用户页面是否符合这个需求。

Answer 1

您可以花一些时间将DocBlock放入您构建的所有功能/类中

像PHPDOC这样的工具可以将DocBlock编译成文档并重新生成您需要的任何内容（按照您想要的格式）。

更不用说，存储为静态HTML

Answer 2

你可能想看看TechWriter for Web Services。它还支持为REST API生成文档。