Lua中文档类型使用的约定是什么？

如果你想参考Lua社区（或某个特定社区）中的想法和观点来了解Lua风格，可以阅读 LuaStyleGuide。

最接近强制风格的是由LuaDoc使用的格式，因为它是一个相当受欢迎的文档生成器，被像LuaFileSystem这样的高调项目所使用。

Lua 只有七种类型。

以下是一些惯例 (其中一些可能听起来有些显而易见，请原谅)：

• 任何听起来像字符串的，应该是字符串：street_address，request_method。如果您不确定，可以添加 _name （或任何其他可以明确表示它是名词的后缀）：method_name。

• 任何听起来像数字的，应该是数字：mass，temperature，percentage。当有疑问时，可以添加 number、amount、coefficient 或其他合适的词：number_of_children，user_id。数字通常用 n 和 i 表示。如果必须是正数或自然数，请在函数顶部进行断言。

• 布尔参数可以是形容词(cold，dirty)或 is_<adjective> (is_wet, is_ready)。

• 任何听起来像动词的，应该是函数：consume，check。如果需要进一步澄清，可以添加 _function，_callback 或 _f：update_function，post_callback。单个字母 f 经常用来表示函数。而且通常您应该只有一个函数类型的参数（推荐放在最后）。

• 任何听起来像集合的，应该是表：children，words，dictionary。通常人们不区分类似数组的表和类似字典的表，因为两者都可以用 pairs 解析。如果您需要指定一个表是一个数组，可以在名称末尾添加 _array 或 _sequence。字母 t 通常表示表。

• 协程不经常使用；您可以遵循与函数相同的规则，还可以将 _cor 添加到它们的名称中。

• 任何值都可以是 nil。

  • 如果是可选值，请在函数顶部初始化它：options = options or {}
  • 如果是强制值，请进行断言 (或返回错误)：assert(name, "The name is mandatory")。