Java之路:註釋
阿新 • • 發佈:2018-12-08
註釋
分類
(1)單行註釋
單行註釋就是在註釋內容前面加雙斜線(//),Java編譯器會忽略這部分資訊。如下所示:
int num; // 定義一個整數
(2)多行註釋
在註釋內容的前面以單斜槓加一個星形標記(/*)開頭,並在註釋內容末尾以一個星形標記加單斜槓結束。當註釋內容超過一行時一般用這種方法。如下所示:
/* int c = 10;
String s = "hello"; */
不過,一般為了美觀,會像下面這樣寫:
/*
* int c = 10;
* String s = "hello";
*/
(3)文件註釋
以單斜線加兩個星形(/**)開頭,並以一個星形標記(*)加一個單斜線(/)結束。用這種方法註釋的內容會被解釋成程式的正式文件,並能包含進如javadoc
package hello;
/**
* @author XY
* @ClassName Hello
* @Description 這是Java的一個簡單範例
* @date 2018/12/1 22:37
*/
public class Hello {
public static void main(String[] args) {
System.out.println("Hello world!");
}
}
通常,在程式的開頭加入作者、時間、版本、要實現的功能等內容註釋,方便後來的維護以及程式設計師的交流。
需要注意的是,註釋文件第2~5行前面的星號並不是必須的,只是為了美觀才加入的。