使用狮身人面像生成PHP代码文档？[已关闭]

根据我的经验，Sphinx和ReST可以用作通用的文档工具。关于Sphinx，没有什么要求你只将其用于基于Python的项目。例如，在我的工作中，我用它来构建用户指南和XML-RPC API参考。在这两种情况下，我都没有使用或其他特定于Python的附加功能。文档是“手工”编写的，主要是通用的ReST指令，而不是Sphinx提供的专业指令。就其价值而言，我还没有需要为非Python文档创建自定义ReST指令。sphinx.ext.autodoc

即使你正在使用PHP项目，我想你也会发现Sphinx很有用。例如，模块特定标记提供的大多数指令实际上都非常通用。我不明白为什么你不能或不会使用这些结构来记录Python以外的语言的东西。同样，Sphinx可以很容易地用其他语言显示代码示例。甚至还有一个配置值可以将默认值更改为Pygments支持的任何语言（包括PHP）。如果你觉得自己特别雄心勃勃，你甚至可以创建一个Sphinx扩展，从你的PHP代码中提取一些相关的东西。

总而言之，请务必考虑文档项目的受众。虽然我认为Sphinx是一个很好的工具，并且会推荐它用于广泛的文档项目，但如果你的观众期待其他东西，请注意这一点。例如，如果您正在记录一个 Java 项目，那么您的许多受众可能会期待 Javadoc 样式的文档。如果你偏离了这个期望，确保它不仅仅是为了踢球（即，它给你提供了比你本来得到的更好的文档），并准备好（简要地）说明你做了什么不同的事情（例如，通过常见问题解答或介绍）。

最后，任何文档都比没有文档好，无论用于创建它们的工具如何。使用任何可以帮助您的工具，如果这是将某些东西放在那里与不在那里之间的区别。

几天前刚刚发布： http://mark-story.com/posts/view/sphinx-phpdomain-released