我正在开发一个相当大的开源RTS游戏引擎（Spring）。我最近添加了一堆可由Lua调用的新C ++函数，我想知道如何最好地记录它们，同时也激发人们为现有Lua调用的编写/更新文档 - 奏。
所以我认为如果我最初可以将文档编写为C ++函数附近的doxygen注释可能会很好 - 这很容易，因为函数体明确定义了函数的功能。但是，我希望游戏开发人员使用引擎来改进文档，因为引擎通常对git（我们使用的VCS）或C ++几乎一无所知。
因此，如果有一种方法可以自动生成C ++文件中的apidocs，而且还有一个类似wiki的Web界面，允许更广泛的受众更新注释，添加示例等，那将是理想的。 / p>
所以我想知道，是否存在一个web工具，它集成了doxygen样式格式，对这些注释进行类似wiki的编辑（最好不允许编辑源文件的任何其他部分）和git？ （将通过Web界面更改的注释提交到特殊分支）
然后我们的开发人员可以不时地合并这个分支，然后将改进添加到主分支，同时开发人员对文档的任何改进最终都会在这个Web工具上完成，只需合并主分支进入这个特殊的分支。
我还没有找到任何东西，怀疑这个具体存在的东西，所以欢迎任何建议！
答案 0 :(得分：6)
这确实是一个非常酷的想法，几年前我也非常需要这样的东西。不幸的是，至少在那时，我无法找到类似的东西。快速搜索sourceforge和freshmeat也没有提出今天的任何相关内容。
但我同意这样的wiki前端用户提供的文档非常有用，我知道最近在Lua社区内也讨论过这样的事情（参见this）。
那么，也许我们可以确定要求以提出基本的工作草案/原型？
希望这会让我们开始使用最少的一组功能启动这样的项目，然后将其作为开源项目（例如在sourceforge上）发布到野外，以便其他用户可以为此做出贡献。 / p>
理想情况下，可以使用统一补丁来应用以这种方式提供的更改。此外，将修改仅限于添加/编辑注释可能是有意义的，而不是允许对文本进行任意修改，这可能通过使用简单的正则表达式来实现。
也许，可以通过修改现有的（已建立的）wiki软件（例如mediawiki）来实现类似的功能。或者最好是已经使用git作为后端用于存储目的的东西。然后，主要需要满足那些Doxygen风格的评论，并在其上提供一个简单的界面。
再考虑一下，DoxyGen本身已经为生成HTML文档提供了支持，所以从这个角度来看，实际上很有趣的是，DoxyGen可能如何扩展，以便它与这样的脚本后端很好地集成在一起。允许轻松自定义嵌入式源代码文档。
这可能主要归结为提供带有doxygen的独立脚本（例如在python，php或perl中），然后可选地在自动创建的HTML文档中嵌入表单，以便可以将文档修复/扩充发送到相应的脚本通过浏览器，反过来会将任何修改写回相应的分支。
从长远来看，如果这样的脚本支持不同类型的后端（CVS，SVN或git），或者至少可以完全实现，那么它很容易扩展。
因此，如果我们能够提出一个好的设计，甚至有可能这种修改通常被认为是对doxygen本身的贡献，这也会给整个事物提供更多的曝光和动力。
即使这个想法没有直接实现到一个真实的项目中，看到有多少其他用户真正喜欢这个想法会很有趣，因此可以在doxygen问题跟踪器中提及它（https://github.com/doxygen/doxygen/issues/new ）。
编辑：您可能还想查看标题为this的"Documentation, Git and MediaWiki"文章。