注解

注解

> LeekScript

目前共有 7 种注解。它们可以写在函数或方法前面,用来提供额外的信息。注解也适用于局部变量、全局变量和类。在编辑器中,把鼠标悬停在注解上,就会显示它的说明文档。

如何使用注解?

要使用注解,可以这样写:

或者

多个注解也可以叠加使用:

现有的注解

@deprecated

调用标注了 @deprecated 的函数或方法时,编译器会显示一个警告。这表示该函数不应再使用,以后会被删除。

例如:

@todo

标注了 @todo 的函数或方法会在编译时产生一条 todo 类型的警告,表示它还没有完成。

@unused

标注了 @unused 的函数或方法即使没有被使用,也不会产生警告。在严格模式下,如果某个函数已经实现,但代码中还没有调用它,这个注解就特别有用。

例如:

注意:给名称加上前缀 _(例如 var _resultat)本身就能消除“未使用”警告,无需注解。

@nodiscard

标注了 @nodiscard 的函数或方法,如果返回值没有被使用,就会显示一个警告。

@pure

目前,@pure 的效果与 @nodiscard 相同。不过,@pure 的含义更多:

纯函数不能改变状态,也不能有副作用。也就是说,它不能修改其作用域之外的变量,并且必须是确定性的(不能用随机数)。

@override

标注了 @override 的方法向开发者表明,它重写了父类中某个方法的实现。

例如:

@tailrec

标注了 @tailrec 的函数或方法表示它是尾递归的:也就是说,这个函数是递归函数,并且递归调用是函数的最后一条指令。

这个注解可能对编译器有用,但目前还没有任何地方用到它。