Java開發編程規範

來源:互聯網
上載者:User

命名規範

定義這個規範的目的是讓項目中所有的文檔都看起來像一個人寫的,增加可讀性,減少項目組中因為換人而帶來的損失。(這些規範並不是一定要絕對遵守,但是一定要讓程式有良好的可讀性)

Package 的命名

Package 的名字應該都是由一個小寫單片語成。

Class 的命名

Class 的名字必須由大寫字母開頭而其他字母都小寫單片語成

Class 變數的命名

變數的名字必須用一個小寫字母開頭。後面的單詞用大寫字母開頭。

Static Final 變數的命名

Static Final 變數的名字應該都大寫,並且指出完整含義。

參數的命名

參數的名字必須和變數的命名規範一致。

數組的命名

數組應該總是用下面的方式來命名:

byte[] buffer;

而不是:

byte buffer[];

方法的參數

使用有意義的參數命名,如果可能的話,使用和要賦值的欄位一樣的名字:

SetCounter(int size){
this.size = size;
}

Java 檔案樣式

所有的 Java(*.java) 檔案都必須遵守如下的樣式規則

著作權資訊

著作權資訊必須在 java 檔案的開頭,比如:

/**
* Copyright ® 2000 Shanghai XXX Co. Ltd.
* All right reserved.
*/

其他不需要出現在 javadoc 的資訊也可以包含在這裡。

Package/Imports

package 行要在 import 行之前,import 中標準的包名要在本地的包名之前,而且按照字母順序排列。如果 import 行中包含了同一個包中的不同子目錄,則應該用 * 來處理。

package hotlava.net.stats;

import java.io.*;
import java.util.Observable;
import hotlava.util.Application;

這裡 java.io.* 使用來代替InputStream and OutputStream 的。

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.