专栏首页DevOps持续交付Groovy语法系列教程之注释(一)

Groovy语法系列教程之注释(一)

Groovy语法概述

本系列教程介绍Groovy编程语言的语法。Groovy的语法源自Java语法,但是通过特定结构对其进行了增强,并允许进行某些简化。

1. 注释

1.1 单行注释

单行注释以//开头,可以在行中的任何位置使用。 //后面的字符(直到该行的末尾)被视为注释的一部分。

// 独立的单行注释
println("我的博客:https://shanyshanb.com/") // 此处开始直至行尾的注释

1.2 多行注释

多行注释以/*开头,可以在该行的任何位置使用。/ *后面的字符将被视为注释的一部分,包括换行符,直到第一个*/结束注释。因此,多行注释可以放在语句的末尾,甚至可以放在语句的内部。

/* 独立的多行注释
   占用两行 */
println "我的博客:https://shanyshanb.com/" /* 多行注释的开始
                   多行注释的结束 */
println 1 /* 注释:一 */ + 2 /* 注释:二 */

1.3 Groovydoc注释

与多行注释类似,Groovydoc注释是多行注释,但以/**开头,以*/结尾。

Groovydoc第一条注释行之后的行可以选择以星号*开头。

这些注释与如下概念有关:

  • 类型定义(类、接口、枚举、注解)
  • 字段和属性定义
  • 方法定义

如果不在上述概念处添加Groovydoc,编译器不会告警。但应该在这些结构之前加上注释。

/**
 * 类的注释
 */
class Person {
    /** Person的名字 */
    String name

    /**
     * 创建打招呼方法
     *
     * @param otherPerson 打招呼的对象
     * @return 打招呼的内容
     */
    String greet(String otherPerson) {
       "你好, ${otherPerson}"
    }
}

Groovydoc遵循与Java的Javadoc相同的约定。因此,也可以使用与Javadoc相同的标签。

1.4 shebang行

有一种特殊的单行注释,通常被UNIX系统称之为shebang行

它使脚本可以直接从命令行运行。前提是你安装了Groovy发行版,并在PATH中配置了groovy命令。

#!/usr/bin/env groovy
println "你好!我的博客:https://shanyshanb.com/"

字符必须是文件的第一个字符。任何缩进都会产生编译错误。

本文分享自微信公众号 - 左手编程右手文化(shanyshanb),作者:左手编程右手文化

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2020-03-01

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 小白前端入门笔记(五),使用注释

    一方面注释可以把一些暂时用不到,但是以后随时可能用到的代码保留起来,是它不会影响运行结果。另外一方面注释也可以给开发人员一些提示,更好地理解代码的逻辑。这段话用...

    TechFlow-承志
  • Java基础系列(十一):注释

    曾经看到过一句话:“我最烦的就是写注释和看不写注释的代码”,也许有玩笑的成分的在,但是不可否认的是,注释对于代码来说,是必不可少的,它可以大大的增加代码的可读性...

    山禾说
  • 编写高质量可维护的代码:一目了然的注释

    有一些人认为,好的代码是自我解释的。合适的命名和优秀的代码的确可以减轻开发人员阅读代码的工作量,对于不是特别复杂的代码可能确实可以做到自我解释。但并不是所有场景...

    政采云前端团队
  • C++注释风格建议

    有个笑话,一位从不写注释的程序员在编写一段复杂的代码时,骄傲地认为这段代码只有自己和上帝知道它是干嘛的,等过了一段时间再回顾时,发现没有注释,感叹到这段代码现在...

    Dabelv
  • 代码洁癖系列(四):可忽略的注释

    刚开始学编程的时候,老师就告诉我们,注释很重要,但是一直到现在,也没有人真正告诉过我要怎么写注释。还有很多人甚至干脆不写注释。所以今天想聊一下到底如何写注释。

    Jackeyzhe
  • 客户让你给代码加注释怎么办?

    作为乙方,我以前听过一些同事说客户要求给代码加注释,一开始自己不以为然,直到有一天这件事情发生在我身上:某大有可为的项目接近尾声,准备下项目前一周,PM说接到客...

    袁慎建@ThoughtWorks
  • Python注释用法

    在Python中的注释与其他语言相比有很大的不同,但使用起来也很简单。在Python中有两种注释,一种是单行注释,一种是多行注释。单行注释适用于简短快速的注释(...

    marsggbo

扫码关注云+社区

领取腾讯云代金券