注解

注解

> LeekScript

目前共有 7 种注解。它们可以放在函数或方法之前，用来标明附加信息。它们也适用于局部变量、全局变量和类。在编辑器中，将鼠标悬停在注解上即可显示它的文档。

如何使用注解？

要使用注解，你可以这样写：

或者

注解也可以叠加使用：

现有的注解

@deprecated

标注了 @deprecated 的函数或方法在被调用时会在编译时显示一条警告。这表示该函数不应再被使用，并且将来会被删除。

例如：

@todo

标注了 @todo 的函数或方法会在编译时插入一条 todo 类型的警告，表示它尚未完成。

@unused

标注了 @unused 的函数或方法在未被使用时不会发出警告。这在严格模式下特别有用：函数已经实现了，但代码并没有调用它。

例如：

注意：在名称前加上 _ 前缀（例如 var _resultat）本身就能消除“未使用”警告，无需注解。

@nodiscard

标注了 @nodiscard 的函数或方法在其返回值未被使用时会显示一条警告。

@pure

目前，@pure 的效果与 @nodiscard 相同。不过，@pure 蕴含着更多的含义：

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

@override

标注了 @override 的方法向开发者表明，它改变了父类中某个方法的实现。

例如：

@tailrec

标注了 @tailrec 的函数或方法表示它是尾递归的：这意味着该函数是递归的，并且递归调用是函数的最后一条指令。

这个注解可能对编译器有用，但目前从未被使用。