命名、格式和註釋

標識符

回顧一下上次我們寫的程序,就會發現,程序源文件的名字(不帶後綴名)和public class後面的類名是一樣的。這是關於文件名和類名的一個規定:
程序源文件名必須和public修飾的類的類名一致
換個角度講,如果程序中的類,沒有使用public修飾,那麼源文件名可以和類名不同,而且一個源文件中可以寫多個類,但只有一個類可以用public修飾。。
是不是感覺有點複雜?我們把它簡化一下:
每個程序源文件中只定義一個類,源文件名和類名保持一致
既然提到了“名字”,我們就來了解一下Java中對名字的規定。
在編程過程中,我們有很多地方都需要取名字,比如上面提到的類的名字,源文件的名字;再比如代碼中String name;,這個name就是爲創建的一個String(字符創)類型的對象起的名字。這些名字在Java中統稱爲標識符。命名標識符時,需要遵守以下規則:

  • 嚴格區分大小寫;
  • 只能由字母、數字、下劃線(_)和美元符號($)組成
  • 不能用數字開頭
  • 不能和關鍵字相同

說明:

  • 所謂關鍵字,就是Java中有特殊用途的一些詞語,例如前面用過的publicclass
  • 在同一個作用域中,標識符也是不能重複的。作用域的概念在後面會講到
  • 上述規則中提到的字母包含任何合法的Unicode字符,例如漢字,但不建議這麼做,最好只使用英文字母
  • 標識符的長度沒有明確限制,但建議不超過255個字符

在實際開發過程中,爲了做到“見名知意”,往往會用多個單詞組合成一個標識符。這時,除了遵守這些基本規則外,爲了代碼更加清晰易讀,大家還會遵守一些命名習慣:

  • 爲類、接口命名時,首字母大寫,其後每個單詞首字母大寫
  • 爲方法命名時,首字母小寫,其後每個單詞首字母大寫
  • 爲變量命名,首字母小寫,其後每個單詞首字母大寫
  • 爲常量命名時,所有字母大寫,多個單詞之間用下劃線隔開
  • 爲包命名時,所有字母小寫

代碼格式

Java語言對代碼格式並沒有嚴格的要求,只要保證:

  • 每句代碼用分號;結尾
  • 成對的符號(例如(),[],{}等)必須成對出現

爲了提高代碼的可讀性,一般會要求代碼遵守一定的格式。可以選擇風格比較多,具體要求也比較多,這裏不做詳細說明,只提供一個方法:在代碼編輯區點擊鼠標右鍵,在彈出的菜單中選擇Source-->Format,Eclipse就可以爲代碼格式化。

其他IDE的操作方法與此類似,不再贅述。
建議今後在程序編寫完成時,先對代碼進行格式化,再進行其它操作。這樣代碼看起來更加清晰,也更容易維護。

註釋

註釋是程序中非常重要的部分,註釋用於爲程序添加說明性的文字,幫助人們更容易看懂程序。Java中有三種註釋:

  • 行註釋,以//開頭,換行時結束,用於進行簡單描述,一般寫在代碼結尾處或者被註釋部分的上方
  • 塊註釋,以/*開頭,以*/結束,不限制行數,用於對整個源文件進行說明或進行相信說明,一般寫在源文件開頭部分或被註釋部分的上方
  • 文檔註釋,以/**開頭,以*/結束,不限制行數,用於生成當前源文件的文檔。有了文檔註釋,就不需要另外編寫一個手冊來說明每個源文件中包含什麼程序,應該怎麼使用了,寫註釋的時候寫下文檔註釋,然後用工具自動抓取這些註釋並生成文檔即可。

上一次對程序的說明,如果添上註釋,可以寫成這樣(這裏僅僅針對程序進行簡單的註釋,工作中往往還需要做文檔註釋):

/*
本程序要求用戶輸入自己姓名,程序會結合用戶的輸入輸出合適的問候語
例如,用戶輸入“張三”,程序則輸出“hello 張三”
*/

import java.util.Scanner;
public class Hello {
    public static void main(String[] args) {
        //提示用戶輸入自己的名字
        System.out.println("請輸入您的姓名:");
        //將用戶輸入的名字保存到name對象中
        Scanner sc=new Scanner(System.in);
        String name;
        name=sc.next();
        //輸出問候語
        System.out.println("hello "+name);
    }
}

很多人會覺得註釋寫不寫、怎麼寫都對程序沒有一分一毫的影響,所以能少寫就少些,能不寫就不寫,這種想法是錯誤的。
有句話說得好:程序不是寫出來的,是改出來的。那種一氣呵成並且完美無缺的程序只存在於傳說中,所以現實中寫程序,必然要面臨修改的命運。不光修改別人的程序會有看不懂的可能,就連修改自己前幾天寫的程序都很有可能看不懂。所以,必須養成爲程序添加適當註釋的習慣。

語句和表達式

Java中的代碼主要由語句和表達式構成。
語句包括結構定義語句和功能執行語句。結構定義語句用於定義程序的結構,如定義類,定義方法等;功能執行語句用於實現一個特定的功能,如定義變量、調用方法等。
結構定義語句一般包含一對大括號,相關代碼就寫在這對大括號當中。
功能執行語句必須以分號;結尾。
單獨的分號也可以算是一個語句,不過不實現任何功能罷了。一般當做佔位符,表明此處還有程序要寫。
在流程控制語句中會用大括號把若干個語句括起來,合併成一個複合語句,在地位上和單個語句相同,功能則是所有括起來的語句的功能之和。
還可以用大括號把一部分語句括起來,形成語句塊(和複合語句不同),具有特殊的作用,在後面會進行詳細說明。
在Java中,一個表示運算的式子被稱爲表達式。例如a+b5*9等。
表達式後面加個分號,也是一個語句。

 

02

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章