Groovy語法系列教程之注釋(一)
- 2020 年 3 月 10 日
- 筆記
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/"
#
字元必須是文件的第一個字元。任何縮進都會產生編譯錯誤。