C++ 是否存在一个；维基；用于编辑doxygen注释？

我正在开发一个相当大的开源RTS游戏引擎（）。我最近添加了一组新的C++函数，这些函数由Lua调用，我想知道如何最好地记录它们，同时也会激发人们编写/更新现有LUA调用的文档。 <> P>所以我想如果我能把文档最初写为C++函数附近的doxGEY注释，那就太好了，因为函数体明确地定义了函数的功能，这很容易。但是，我希望游戏开发人员使用的引擎能够改进文档，他们一般对Git（我们使用的VCS）或C++没有什么了解。 <> P>因此，如果有一种方法可以从C++文件自动生成APIDOCS，那么也可以有一个wiki类的Web界面，允许更广泛的用户更新评论、添加示例等。 所以我想知道，是否有一个web工具集成了doxygen样式的格式、类似wiki的对这些评论的编辑（最好不允许编辑源文件的任何其他部分）和git？（将通过web界面更改的注释提交给特殊分支）

我们开发人员可以不时地合并这个分支，将改进添加到主分支中，同时，开发人员对文档的任何改进最终都会出现在这个web工具上，只需将主分支合并到这个特殊分支中

---

我还没有发现任何东西，怀疑这个特定的东西是否存在，所以欢迎任何建议

这确实是一个非常酷的想法，几年前我也非常需要这样的东西。不幸的是，至少在当时，我没有找到这样的东西。在sourceforge和freshmeat上快速搜索也不会带来任何与今天相关的内容

但是我同意这样一个wiki前端到用户贡献的文档是非常有用的，我知道最近Lua社区也在讨论类似的事情（参见）

那么，也许我们可以确定需求，从而得出一个基本的工作草案/原型

希望这能让我们用最少的一组特性来启动这样一个项目，然后简单地将它作为一个开源项目（例如在sourceforge上）发布到野外，以便其他用户能够为它做出贡献

理想情况下，可以使用统一补丁来应用以这种方式进行的更改。此外，将修改仅限于添加/编辑注释可能是有意义的，而不是允许对文本进行任意修改，这可能可以通过使用简单的正则表达式来实现

也许，可以通过修改现有（已建立的）wiki软件（如mediawiki）来实现类似的功能。或者最好是已经使用git作为后端进行存储的东西。然后，主要需要迎合那些Doxygen风格的评论，并在上面提供一个简单的界面

再想一想，DoxyGen本身已经提供了对生成HTML文档的支持，因此从这个角度来看，DoxyGen如何扩展，以便与这样一个脚本化的后端很好地集成，从而可以轻松定制嵌入式源代码文档，这可能是一件有趣的事情

这可能主要归结为使用doxygen（例如python、php或perl）提供独立脚本，然后在自动创建的HTML文档中选择性地嵌入表单，以便可以通过浏览器将文档修复/扩充发送到相应的脚本，这反过来会将任何修改写回相应的分支

从长远来看，如果这样一个脚本能够支持不同类型的后端（CVS、SVN或git），或者至少能够实现足够的通用性，从而易于扩展，那就太酷了

因此，如果我们能想出一个好的设计，甚至有可能这样的修改会被普遍接受为对强氧本身的贡献，这也会给整个过程带来更多的曝光和动力

即使这个想法没有直接落实到一个真正的项目中，看看有多少其他用户真正喜欢这个想法也是很有趣的，这样就有可能在doxygen问题跟踪程序（）中提到它

---

编辑：您可能还想查看标题为的文章。

+1，非常酷。。。这可能真的很有用，如果它能够使格式化文档的编辑体验比编辑（有时是隐晦的）标记的编辑体验更好的话，可能对“核心开发人员”也很有用。好的一点，我甚至没有想到：-）鉴于总体的正面反馈，我会考虑开始一个新的问题，询问人们是否愿意使用这样的东西（赞成和反对），并可能详细说明他们对“源代码文档wiki”的要求。在我当前的考试期结束后，我会尽量找时间来做。如果你对这篇文章有任何更新，我很想知道。我刚刚回答了另一个相关的SO问题，关于我们目前不使用这样的wiki来做这件事的方式（显然，我们更希望有一个与所使用的SCM系统很好地集成的wiki解决方案）：