註解
什麼是註解?
註解是我們在寫程式碼時某段程式碼、某個方法、某個類別的說明文字,方便大家對於程式碼的閱讀。被註釋的內容不會被編譯、執行。
java的註解分為三種類型:單行註解、多行註解、文件註解。
單行註解和多行註解
單行註解在程式中註解一行文字或程式碼,Java中,使用「//」進行單行註解。多行註解可以一次將多行程式碼註釋,Java中使用「/*」表示多行註解開頭,「*/」表示多行註解結尾
例:
public class CommentTest{ public static void main(String[] args){ //这是单行注释 /* 多行注释第一行 第二行 */ //System.out.PRintln("被注释的代码不会编译和运行"); System.out.println("未被注释的代码"); } }
Eclipse註解快速鍵:Ctrl+/ 單行註解和取消註釋;Ctrl+Shift+/ 添加/* */註釋;Ctrl+Shift+ 消除/* */註釋
文檔註釋
使用文檔註釋添加的註釋可以透過文檔生成工具javadoc生成API文檔,javadoc工具只處理文件來源文中的以public和protected修飾的類別、介面、方法、Field、建構子和內部類別前面的註解。
文件註解以「/**”開頭,以“*/」結尾。中間的部分是文檔註釋,會被產生到API文檔中。
例:
/** * 这是一个文档注释的测试类 * @author ping * */public class Test { /** 这是一个Filed */ public int i; /** * 这是程序的main方法 * @param args */ public static void main(String[] args) { } }
關於產生JavaAPI文檔,可以參考以下兩篇文章:
用javadoc指令產生api幫助文檔
eclipse如何產生什麼來產生元
eclipse分隔符號包括分號(;)、花括號({})、方括號([])、圓括號(())、空格、圓點(.),所有的符號都為英文符號,這點在寫程式碼的時候要特別注意。 分號:,Java中,換行不能代表語句結束,只有分號代表一個語句的結束,因此一行中理論上是可以寫多個語句,但不建議這麼寫,會影響程式碼的可讀性,使程式碼看起來雜亂。 花括號:一對花括號代表語句塊,需要成對出現。 方括號:用做數組,定義數組和存取數組元素時使用,也需要成對使用。 圓括號:定義方法時用來包含形參,呼叫方法和構造方法,需要有圓括號。 空格:用來分割一個語句的多個部分。 圓點:用作使用物件和類別的成員使用。 標識符標識符是用來為程式中的類別、方法、變數命名的符號。 Java標識符具有以下特點:區分大小寫。 必須以字元、底線、美元符號開頭,後面可以跟字元、底線、美元符號和數字四種元素。字符不限於英文字符,可以是漢字等各國的文字。 不能包含下劃線其他的特殊符號以及空格等。 不能是Java中的關鍵字。 public class Test{ //Test是識別碼 public static void main(String[] args){ //main args也是一個識別碼int a = 1;
〠/1a;兩個不同的識別碼int $i = 2; //標識符正確int 123 = 123; //標識符錯誤int i123 = 123; //標識符正確int i_1 = 1; //正確int i.1 = 1; //錯誤int class = 2; //class是關鍵字,錯誤}
}