我正在开发一个相当大的开源 RTS 游戏引擎 (Spring)。我最近添加了一堆可由 Lua 调用的新 C++ 函数，我想知道如何最好地记录它们，同时也鼓励人们为 很多 现有的 Lua 调用编写/更新文档-出局。
所以我认为，如果我最初可以将文档编写为靠近 C++ 函数的 doxygen 注释，那可能会很好——这很容易，因为函数体显然准确地定义了函数的作用。但是，我希望使用引擎的游戏开发人员能够改进文档，他们通常对 git(我们使用的 VCS)或 C++ 了解甚少。
因此，如果有一种方法可以从 C++ 文件自动生成 apidocs，而且还具有类似 wiki 的 Web 界面，以允许更广泛的受众更新评论、添加示例等，那将是理想的选择。
所以我想知道，是否存在一个集成了 doxygen 样式格式、对这些评论进行类似 wiki 的编辑(最好不允许编辑源文件的任何其他部分)和 git 的网络工具？ (将通过 Web 界面更改的评论提交到特殊分支)
然后，我们开发人员可以不时 merge 此分支以将改进添加到 master 分支，同时开发人员对文档的任何改进最终将在此 web 工具上结束，只需 merge master 分支进入这个特殊的分支。
我还没有找到任何东西，怀疑这个特定的东西是否存在，所以欢迎任何建议!
最佳答案
这确实是一个非常酷的想法，几年前我也非常需要类似的东西。不幸的是，至少在那时，我无法找到类似的东西。对 sourceforge 和 freshmeat 进行快速搜索也没有找到任何相关内容。
但我同意这样一个用户贡献文档的 wiki 前端会非常有用，我知道最近 Lua 社区也在讨论类似的事情(参见 this)。
那么，也许我们可以确定需求以提出基本的工作草案/原型(prototype)？
希望这能让我们启动这样一个具有最少功能集的项目，然后简单地将其作为开源项目发布到野外(例如在 sourceforge 上)，以便其他用户可以为它做出贡献。
理想情况下，可以使用统一补丁来应用以这种方式贡献的更改。此外，将修改限制为仅添加/编辑注释可能是有意义的，而不是允许任意修改文本，这可能可以通过使用简单的正则表达式来实现。
也许，可以通过修改现有的(已建立的)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" 的文章.
关于c++ - 是否存在用于编辑 doxygen 评论的 "wiki"？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/930622/
我正在尝试测试是否存在表单。我是Rails新手。我的new.html.erb_spec.rb文件的内容是:require'spec_helper'describe"messages/new.html.erb"doit"shouldrendertheform"dorender'/messages/new.html.erb'reponse.shouldhave_form_putting_to(@message)with_submit_buttonendendView本身，new.html.erb，有代码:当我运行rspec时，它失败了:1)messages/new.html.erbshou
我在从html页面生成PDF时遇到问题。我正在使用PDFkit。在安装它的过程中，我注意到我需要wkhtmltopdf。所以我也安装了它。我做了PDFkit的文档所说的一切......现在我在尝试加载PDF时遇到了这个错误。这里是错误:commandfailed:"/usr/local/bin/wkhtmltopdf""--margin-right""0.75in""--page-size""Letter""--margin-top""0.75in""--margin-bottom""0.75in""--encoding""UTF-8""--margin-left""0.75in""-
给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息？ 最佳答案 在Rails3中，update_all不返回任何有意义的信息，除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru
我得到了一个包含嵌套链接的表单。编辑时链接字段为空的问题。这是我的表格:Editingkategori{:action=>'update',:id=>@konkurrancer.id})do|f|%>'Trackingurl',:style=>'width:500;'%>'Editkonkurrence'%>|我的konkurrencer模型:has_one:link我的链接模型:classLink我的konkurrancer编辑操作:defedit@konkurrancer=Konkurrancer.find(params[:id])@konkurrancer.link_attrib
大约一年前，我决定确保每个包含非唯一文本的Flash通知都将从模块中的方法中获取文本。我这样做的最初原因是为了避免一遍又一遍地输入相同的字符串。如果我想更改措辞，我可以在一个地方轻松完成，而且一遍又一遍地重复同一件事而出现拼写错误的可能性也会降低。我最终得到的是这样的:moduleMessagesdefformat_error_messages(errors)errors.map{|attribute,message|"Error:#{attribute.to_s.titleize}#{message}."}enddeferror_message_could_not_find(obje
为了将Cucumber用于命令行脚本，我按照提供的说明安装了arubagem。它在我的Gemfile中，我可以验证是否安装了正确的版本并且我已经包含了require'aruba/cucumber'在'features/env.rb'中为了确保它能正常工作，我写了以下场景:@announceScenario:Testingcucumber/arubaGivenablankslateThentheoutputfrom"ls-la"shouldcontain"drw"假设事情应该失败。它确实失败了，但失败的原因是错误的:@announceScenario:Testingcucumber/ar
我的瘦服务器配置了nginx，我的ROR应用程序正在它们上运行。在我发布代码更新时运行thinrestart会给我的应用程序带来一些停机时间。我试图弄清楚如何优雅地重启正在运行的Thin实例，但找不到好的解决方案。有没有人能做到这一点？ 最佳答案 #Restartjustthethinserverdescribedbythatconfigsudothin-C/etc/thin/mysite.ymlrestartNginx将继续运行并代理请求。如果您将Nginx设置为使用多个上游服务器，例如server{listen80;server
这个问题在这里已经有了答案:Checktoseeifanarrayisalreadysorted?(8个答案)关闭9年前。我只是想知道是否有办法检查数组是否在增加？这是我的解决方案，但我正在寻找更漂亮的方法:n=-1@arr.flatten.each{|e|returnfalseife
我遵循MichaelHartl的“RubyonRails教程:学习Web开发”，并创建了检查用户名和电子邮件长度有效性的测试(名称最多50个字符，电子邮件最多255个字符)。test/helpers/application_helper_test.rb的内容是:require'test_helper'classApplicationHelperTest在运行bundleexecraketest时，所有测试都通过了，但我看到以下消息在最后被标记为错误:ERROR["test_full_title_helper",ApplicationHelperTest,1.820016791]test
我有一个包含多个键的散列和一个字符串，该字符串不包含散列中的任何键或包含一个键。h={"k1"=>"v1","k2"=>"v2","k3"=>"v3"}s="thisisanexamplestringthatmightoccurwithakeysomewhereinthestringk1(withspecialcharacterslike(^&*$#@!^&&*))"检查s是否包含h中的任何键的最佳方法是什么，如果包含，则返回它包含的键的值？例如，对于上面的h和s的例子，输出应该是v1。编辑:只有字符串是用户定义的。哈希将始终相同。 最佳答案
