函数文档注释

函数文档注释

> LeekScript 教程

!javadoc 函数

从 2.17 版本起，你可以使用 Javadoc 格式为自己的函数编写文档了。

有什么用？

给代码写注释很重要。注释可以说明你在代码中用到的函数、类和方法。这样一来，当你回头去看很久没碰过的代码时会轻松得多；团队协作时，这也是一个好习惯。

怎么写？

JavaDoc 格式非常简单，而 Leek Wars 里的版本还要更简单！你只需要掌握两个关键字：

• @param：用于说明一个参数
• @return：用于说明函数的返回值

JavaDoc 的写法如下：

JavaDoc 写在以 /** */ 包裹的多行注释中。