Java 程式寫作規範
1. Java 的類別及interface名稱必須以大寫字母開頭,其後的word也應該以大寫字母開頭,如Stack 、PriorityQueue等。
2. 物件、變數及方法宣告應該以小寫字母開頭,遇到多個單字組合時,則第二個單字開始應該以大字母開頭,如studentName,doNext,copyElement,setPriority等。
3. 常數宣告應以全部大寫字母開頭,在word與word之間以底線(_)分開。
Final int MIN_WIDTH=4;
Final int MAX_WIDTH=999;
GET_THE_CPU=1;
4. 在Java程式中,各種宣告需要依照下列的排列順序依序宣告(參考Java Code Conventions,Sept 12, 1997);
(1) 程式的基本註解。以C-Style的註解寫作。如:
(2) package 及import 敘述:在Java 語言中第一個非註解的程式碼是package敘述,其次才是import敘述。
(3) 類別及Interface宣告:
l 類別/Interface Web文件式註解。(/* ... */)
l 類別或是Interface敘述。如public class MyClass或是public interface Myinterface。
l 任何關於此類別或是實作Interface時的相關註解。
l 類別(static)變數。先宣告public類別變數,再宣告protected變數,最後再宣告private變數。
l 物件變數。先宣告public物件變數,再宣告protected變數,最後再宣告private物件變數。
l 建構子
l 方法
在處理方法宣告時,應將類似功能的方法集合在一處,而不用考慮是否將public和protected及private方法分開處理。例如,可將private方法放在兩個public方法之間。主要目的是使程式碼的閱讀及瞭解更加便利。
在程式寫作時,遵守這些約定俗成的習慣是很重要的。如此,別人才能很快的了解你寫的程式,能夠立即知道什麼是物件,什麼是類別,而不用時時翻看程式昏原始宣告。
來源
沒有留言:
張貼留言