【Groovy手札】Groovy的几种注释

Groovy共有四种注释方式，下面详细介绍一下：

 

1.1  单行注释

在Groovy中，单行注释以// 开始，可以从一行的任意位置开始，// 后面的字符均为注解部分。例如：

// a standalone single line comment
println "hello world"// a comment till the end ofthe line

 

1.2  多行注释

多行注释以 /* 开始，并且以之后遇到的第一个*/结束，在一个表达式中，这样的注释也是可以存在的，例如：

/*a standalone multiline comment
   spanning two lines */
println "hello"/* a multiline commentstarting
                   at the end of astatement */
println 1 /* one */+2/*two */

 

1.3  GroovyDoc 注释

类似于Java中的JavaDoc注释，GroovyDoc以 /** 开始，并以 */结尾，可用于多行，中间的每行以*作为起始，这种注释可以用于（1）类型定义（class,interface,enum,annotation），（2）域和属性定义，（3）方法定义。

由于GroovyDoc使用与Java自带的JavaDoc相同的文档转换器，所以在JavaDoc中的标签在GroovyDoc中，也可以使用。

例如：

/**
 * A Class description
 */
class Person{
    /** the name of the person */
    Stringname

/**
     * Creates a greeting method for acertain person.
     *
     * @param otherPerson the person togreet
     * @return a greetingmessage
     */
    String greet(String otherPerson) {
       "Hello ${otherPerson}"
    }
}

 

1.4  事务列（Shebang line）

这是一种特殊的行注释方式，允许Groovy脚本在UNIX系统的命令行中直接运行，只要计算机安装了Groovy环境并且PATH系统变量中包含Groovy路径。

例如：

#!/usr/bin/envgroovy
println "Hellofrom the shebang line"

注意 # 必须是该脚本文件的第一个字符（起始字符）！