用途:这是 Motoko 的通用代码风格指南,在处理 *.mo 文件内容时加载,用于规范 Motoko 源码的排版格式与基本约定,提升代码可读性和一致性。
主要能力(均以建议形式给出): 排版方面:规定空格用法,如算术、比较、布尔、赋值、'='、':' 等运算符两侧加空格,逗号或分号后加空格;花括号、括号及方括号内的空格规则;函数、变体标签与参数之间不加空格;访问运算符(. ? ! 及索引括号)两侧不留空格。规定换行:约定固定右边界(如 80 列)并在运算符后断行,长参数列表每个参数独占一行;缩进固定为 2 个空格、禁止使用制表符、不做垂直对齐;用空行和注释分隔逻辑分组。注释:使用行注释,行尾短注释至少隔 2 空格,多行注释置于代码前;标点:块内用分号分隔,行末统一加分号,单行块可省略;花括号、圆括号使用及“无括号”风格的取舍;数字用 _ 分组(十进制每 3 位、十六进制每 4 位)。 命名方面:类型、模块、actor 用 UpperCamelCase,其余用 lowerCamelCase;缩写按普通单词拼写;除标记未使用变量外,不用下划线开头;返回值的函数名描述值本身,避免多余 get 前缀,有副作用的函数名描述操作,返回 Bool 的谓词用 is/has 前缀;类或对象中私有变量以 _ 结尾;全局或公有标识符用更长描述性名称,局部小作用域用短名称;集合用复数形式。 类型标注方面:涉及定宽数值类型的定义加类型标注以消除重载歧义,非 Nat/Int 的算术表达式加内联标注,可变变量除类型明显外加标注,类的公有字段加标注。
适用场景:编写或审阅 Motoko 源码,统一团队代码风格。
限制:资料为风格建议,不含工具安装或自动格式化命令;部分内容(如公有字段标注段落)在资料中未完整给出;其余未提及的能力、平台或效果暂未提供。