系列連載文章,大家可以從我的專欄學習Java入門基礎知識,後續也會有更高級的Java特性、企業級開發框架,也有平常工作中的技術總結和分享,歡迎關注我的CDSN博客。同時可關注微信公衆號“Java開發之旅”,獲得更多技術資料!
目錄
閒言碎語
註釋沒什麼可講的,一切從簡。
註釋,就是對代碼的標註、解釋。當我們的需求越來越複雜、代碼量越來越多,如果沒有註釋,程序就會顯得雜亂無章,過一段時間後你自己都不知道寫的是什麼。
而且,註釋是給開發人員看的,不是給計算機看的。在執行Java程序時,jdk遇到註釋標識符就會忽略掉其中的內容,不進行編譯,所以寫註釋對我們的程序是沒有影響的。
我們鼓勵寫註釋,但是也不能瞎寫,一些一看就明白的操作就不必要寫,比如1+1=2。
在我們寫代碼之前,有必要先養成一個習慣——寫註釋!!!筆者在工作中見過太多的無註釋代碼,曾經從同事手中交接了一個項目,一個.java文件有1000多行代碼,註釋量少得可憐……每天的維護都是在mmp(美美拍)中度過。
話不多說,看一下Java中的三種註釋。
單行註釋
單行註釋,註釋效果僅限於當前行,換行之後就沒效果了。單行註釋以//開頭:
public class Hello {
public static void main(String[] args) {
//單行註釋:打印內容“你好”
System.out.println("你好");
}
}
多行註釋
多行註釋用於內容比較多、需要換行的情況,雖然用多個單行註釋也能實現,但是不如多行註釋優雅。多行註釋/*開頭,以*/結尾:
public class Hello {
/*
* 也可以將多行註釋寫在方法(函數)上,說明方法的用途、參數等等
* 這都是多行註釋的用途
* */
public static void main(String[] args) {
//單行註釋:打印內容“你好”
System.out.println("你好");
/*
* 當需要註釋的內容比較多,最好使用多行註釋,
* 你看,它是可以換行的,而且是任意行,神奇不?
* */
}
}
文檔註釋
文檔註釋多用於註釋類,即.java文件,至於什麼是類我們會在後面介紹。文檔註釋以/**開頭,以*/結尾,而且可以定義作者、版本、時間等信息:
/**
* 第一篇Java程序
*
* @author Java開發之旅
* @version 1.0
* @date 2020-04-03
* */
public class Hello {
/*
* 也可以將多行註釋寫在方法(函數)上,說明方法的用途、參數等等
* 這都是多行註釋的用途
* */
public static void main(String[] args) {
//單行註釋:打印內容“你好”
System.out.println("你好");
/*
* 當需要註釋的內容比較多,最好使用多行註釋,
* 你看,它是可以換行的,而且是任意行,神奇不?
* */
}
}
小結
註釋就是一種備註,用於標註代碼、解釋代碼,讓開發人員更容易地理解代碼。