记录假类

Documenting fake classes

本文关键字：记录更新时间：2023-10-16

我有一个函数，它将所有我需要的c++函数暴露给Lua，有各种表代表我的"脚本API"的不同方面，我想做的是使用氧来使用暴露这些脚本函数的c++代码制作脚本参考。

,我尝试着去"假"类的主体功能,成功地让一个新条目的名称我已经给它,例如如果我做一个名为"数学"这几个函数的表暴露,我怎么也使"假"在这个"假"类的成员函数,我试图仅仅通过在 fn定义函数,但是它不显示为他们实际上并不是真正的成员添加描述。如果不修改每个类的逐字定义，而是将注释块当作具有真实成员的真实类来对待，我如何在实际中创建这种效果呢?

听起来好像你在试图记录Lua代码，就好像它们是c++一样。也许这是可能的，但可能比它的价值更多的麻烦。

如果你想用氧来记录Lua代码，也许你可以试试氧- Lua。

如果你的Lua API很小，你可以手工写一个页面，用ref指向相关的c++代码。(有点粗俗，但我以前做过)

你也可以考虑为你的Lua API使用一些其他的文档生成器，比如LuaDoc，或者Lua -users wiki DocumentingLuaCode上列出的任何东西。

我最后写了一个假的。doxy文件，它的类型名类似于lua值，显然氧会记录任何类型。