草庐IT

c++ - 我应该如何记录用 C++ 代码编写的 Lua API/对象模型？

coder 2023-11-15 原文

我正在为游戏 Bitfighter (http://bitfighter.org) 编写一个新的和扩展的 Lua API。我们的 Lua 对象模型是 C++ 对象模型的一个子集，我需要记录的公开给 Lua 的方法是 C++ 中可用方法的一个子集。我只想记录与 Lua 相关的项目，而忽略其余部分。

例如，对象 BfObject 是所有 Lua 对象的根，但它本身位于 C++ 对象树的中间。 BfObject 有大约 40 个 C++ 方法，其中大约 10 个与 Lua 脚本编写器相关。我希望我们的文档将 BfObject 显示为根对象，并且仅显示这 10 个相关方法。我们还需要以一种使方法继承清晰的方式显示其子对象。

目前我们可以假设所有代码都是用 C++ 编写的。

一个想法是以某种方式标记我们想要记录的对象，这样系统(例如 doxygen)就会知道要查看什么并忽略其余部分。另一种方法是以删除所有不相关位的方式预处理 C++ 代码，并用 doxygen 之类的东西记录剩下的内容。 (实际上我使用 luadoc 的这种方法已经走得很远了，但是找不到让 luadoc 显示对象层次结构的方法。)

可能证明有用的一件事是每个 Lua 对象类及其父类都以一致的方式注册。

越来越多的游戏使用 Lua 编写脚本，其中许多都有不错的文档。有人对如何制作它有好的建议吗？

PS 澄清一下，我很乐意使用任何可以完成这项工作的工具 -- doxygen 和 luadoc 只是我比较熟悉的示例。

最佳答案

我找到了一个解决方案，虽然不理想，但效果很好。我拼凑了一个 Perl 脚本，它撕裂了所有 Bitfighter 源代码并生成了第二组“假”源代码，其中只包含我想要的元素。然后我可以通过 Doxygen 运行这个辅助源，得到的结果是我正在寻找的结果的 95%。

我宣布胜利。

这种方法的一个优点是我可以以一种“自然”的方式记录代码，而不必担心标记什么进什么出。该脚本足够聪明，可以从代码结构中找出它。

如果有人感兴趣，可以在 Bitfighter 源存档中找到 Perl 脚本，网址为 https://code.google.com/p/bitfighter/source/browse/luadoc.pl .它只完成了大约 80%，并且缺少一些非常重要的项目(例如正确显示函数参数)，但是结构就在那里，我很满意这个过程会起作用。该脚本会随着时间的推移而改进。

可以在 http://bitfighter.org/luadocs/index.html 查看该过程的(非常初步的)结果。 .模板几乎没有被修改，所以它看起来很“普通”，但它表明事情或多或少是可行的。

由于一些评论者建议使用 Doxygen 生成好的文档是不可能的，我应该注意到我们几乎没有添加任何内联文档。要了解它们的外观，请参阅 Teleporter 类。它不是很好，但我认为它确实驳斥了 Doxygen 总是产生无用文档的观点。

在这一点上，我的主要遗憾是我的解决方案确实是一次性的，并没有解决我认为社区中日益增长的需求。也许在某个时候，我们将标准化合并 C++ 和 Lua 的方式，并且创建通用文档工具的任务将更易于管理。

PS 您可以看到原始源文件中的标记是什么样的...参见https://code.google.com/p/bitfighter/source/browse/zap/teleporter.cpp , 然后搜索@luaclass

关于c++ - 我应该如何记录用 C++ 代码编写的 Lua API/对象模型？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/12388376/

amp43C++的bitfighterc++luadocumentation-generation

有关c++ - 我应该如何记录用 C++ 代码编写的 Lua API/对象模型？的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri，根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法？ - 2

    总的来说，我对ruby​​还比较陌生，我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础，我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  3. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声？ - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点？我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等)，但我确实想创建一个输出文件。

  4. ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2

    给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息？ 最佳答案 在Rails3中，update_all不返回任何有意义的信息，除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru

  5. ruby-on-rails - Rails - 子类化模型的设计模式是什么？ - 2

    我有一个模型:classItem项目有一个属性“商店”基于存储的值，我希望Item对象对特定方法具有不同的行为。Rails中是否有针对此的通用设计模式？如果方法中没有大的if-else语句，这是如何干净利落地完成的？ 最佳答案 通常通过Single-TableInheritance. 关于ruby-on-rails-Rails-子类化模型的设计模式是什么？，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.co

  6. ruby-on-rails - 按天对 Mongoid 对象进行分组 - 2

    在控制台中反复尝试之后，我想到了这种方法，可以按发生日期对类似activerecord的(Mongoid)对象进行分组。我不确定这是完成此任务的最佳方法，但它确实有效。有没有人有更好的建议，或者这是一个很好的方法？#eventsisanarrayofactiverecord-likeobjectsthatincludeatimeattributeevents.map{|event|#converteventsarrayintoanarrayofhasheswiththedayofthemonthandtheevent{:number=>event.time.day,:event=>ev

  7. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗？当我运行compasswatch时，它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行？文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们？我自己编译的.sass文件编译成compiled/t

  8. ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2

    我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚

  9. ruby - 如何在 buildr 项目中使用 Ruby 代码？ - 2

    如何在buildr项目中使用Ruby？我在很多不同的项目中使用过Ruby、JRuby、Java和Clojure。我目前正在使用我的标准Ruby开发一个模拟应用程序，我想尝试使用Clojure后端(我确实喜欢功能代码)以及JRubygui和测试套件。我还可以看到在未来的不同项目中使用Scala作为后端。我想我要为我的项目尝试一下buildr(http://buildr.apache.org/)，但我注意到buildr似乎没有设置为在项目中使用JRuby代码本身!这看起来有点傻，因为该工具旨在统一通用的JVM语言并且是在ruby中构建的。除了将输出的jar包含在一个独特的、仅限ruby​​

  10. ruby - 如何指定 Rack 处理程序 - 2

    Rackup通过Rack的默认处理程序成功运行任何Rack应用程序。例如:classRackAppdefcall(environment)['200',{'Content-Type'=>'text/html'},["Helloworld"]]endendrunRackApp.new但是当最后一行更改为使用Rack的内置CGI处理程序时，rackup给出“NoMethodErrorat/undefinedmethod`call'fornil:NilClass”:Rack::Handler::CGI.runRackApp.newRack的其他内置处理程序也提出了同样的反对意见。例如Rack

随机推荐