跳转至

注释

Lumos 支持单行注释和多行注释,使用方式与 C 语言类似

单行注释

单行注释以 // 开头,直到行尾结束。

注意:// 之后必须至少有一个空白字符(例如空格或制表符),否则会导致编译错误。

  • 词法单元的 text 字段只包含注释内容;注释起始标记 // 及其后紧接的单个空白字符不包含在 text 中。

多行注释

多行注释以 /* 开头,以 */ 结尾。

注意:/* 之后和 */ 之前应至少包含一个空白字符(例如空格或制表符),否则会导致编译错误。

  • 词法单元的 text 字段只包含注释内部的内容;起始和结束标记以及它们前后的空白不包含在 text 中。

多行注释不得嵌套。

文档注释

文档注释用于为代码元素添加文档说明,支持单行和多行两种形式:

  • 单行文档注释以 /// 开头,直到行尾结束。
  • 多行文档注释以 `` 结尾。

注意:/// 或 `` 之前,应至少包含一个空白字符;否则会导致编译错误。

文档注释必须紧挨其所描述的代码元素(变量、函数、类等)之前,否则可能会被视为普通注释或导致编译错误。

/// 这是一个示例函数
///
/// 它没有任何参数,返回类型为 `unit`
fun example_func() -> unit {
    // 函数体
}
fun example_func() -> unit {
    // 函数体
}

相关内容:词法总览见 词法