Java編碼規範(自己個人小結,供大家參考)
下面是我個人剛學JAVA時,對JAVA編碼規範的一些小結,希望能給大家一些幫助!更詳細的可以查看SUN提供的JAVA編碼規範!
一 命名慣例
1)類:名詞或名詞性片語,每個單詞首字母大寫;一般不使用縮寫,除非其縮寫更通用和便於理解,如HTML;
類命名舉例:class Person; class SpringRain
2)方法:動詞或動詞性片語,首字母小寫,第二個及以後的單詞首字母大寫;
方法命名舉例:run(); displayInformation();
3)介面: 同"類"的命名規則
介面命名舉例:interface Runner;
4)變數: 名詞或名詞性片語,首字母小寫,第二個及以後的單詞首字母大寫;
不提倡使用下畫線"_"和美元符"$"作為變數開頭;單詞間可以使用下畫線分隔;
變數名不宜過長但也應有意義,除非是臨時使用(例如只涉及幾行代碼)后即丟棄
的情況,不建議使用單個字母做變數名,常用的臨時使用的變數名包括表示整數的
i,j,k,m,n和表示字母的c以及表示異常對象的e等.
變數命名舉例:int age; int student_age; String studentName; Exception e;
5)常量:名詞或名詞性片語,每個單詞的首字母大寫;單詞間使用下畫線分隔.
常量命名舉例:int MAX_LEVEL; double Comm_Tax;
6)包: 名詞或名詞性片語,全部小寫;一般使用本公司/組織網站域名的逆序
後跟具體的軟體內部模塊名
包命名舉例: package com.sun.java; package com.mycompany.db;
二 文件組織
1.建議一個源文件中只定義一個Java類或介面,無論該類或介面是否被聲明為pulibc的,
文件名都以其來命名,源文件中各成分的出現順序為:
1)開始的註釋
2)package語句
3)import語句
4)類/介面聲明
2.在一個Java類中,各種成分的排列順序本無嚴格規定,也沒有特別通用的慣例,為便於掌握,給出一個推薦的順序:
1)屬性聲明
2)構造方法聲明
3)static語句
4)普通方法聲明
5)main方法聲明
6)內部類的聲明
三 分隔和縮進
1.使用空行
在下述情況下使用單行的空白行來分隔:
1)在方法之間
2)在方法內部代碼的邏輯段落小節之間
3)在方法中聲明局部變數之後,具體的Java語句之前
4)在註釋行之前
在同一個源文件中定義的多個類/介面之間使用雙行的空白行來分隔
2.使用空格符
除正常的成分之間以空格符分隔名(如數據類型和變數名之間),在下述情況下也應使用一個空格符來分隔:
1)運算符和運算符之間,如: c = a b;
2)在參數列表中的逗號後面,如: void m1(int year, int month) {}
3)在if,for,while待語句之後 如: if (a > b) {}
3.使用換行符
不建議在一行中寫多條語句,一條語句的長度一般超過了80個字元時,應該換行
4.使用小括弧
可以使用小括弧來強行規定運算順序
5.使用花括弧
開始位置可以位於當前內容的尾部,也可以另起一行
6.使用縮進
在下述情況下應用縮進
1)類中的成分
2)方法體或語句塊中的成分
3)換行時的非起始行
縮減量一般為在上一級成分的基礎上再縮進四個空格,或跑到下一個製表位
四 聲明語句
建議每行聲明一個變數,並盡量在聲明變數的同時對其進行初始化,除非其初值尚不確定.局部變數應在其所在的方法或語句塊的開頭集中聲明,而不應隨用隨聲明.
五 下面給出一個程序,結合上面的介紹,注意下Java編碼規範
注意:在eclipse開發工具中,把代碼寫好之後,可以用快捷鍵:CTRL SHIFT F來自動格式化代碼
/**
* Copyright: Copyright (c) 2002-2004
* Company: JavaResearch(http://www.javaresearch.org )
* 最后更新日期:2003年4月3日
* @author Cherami
*/
package org.jr.util;
import java.util.*;
/**
* 此類中封裝一些常用的List操作方法.
* 所有方法都是靜態方法,不需要生成此類的實例,
* 為避免生成此類的實例,構造方法被申明為private類型的.
* @since 0.5
*/
public class ListUtil {
/**
* 私有構造方法,防止類的實例化,工具類不需要實例化.
*/
private ListUtil() {
}
/**
* 將數組中的內容全部添加到列表中.
* @param array 數組
* @param list 列表
* @since 0.5
*/
public static void addArrayToList(Object[] array, List list) {
if (array == null || list == null || array.length == 0) {
return;
}
for (int i = 0; i < array.length; i ) {
list.add(array[i]);
}
}
/**
* 將數組中的內容全部添加到列表中.
* @param array 數組
* @param list 列表
* @param start 開始位置
* @since 0.5
*/
public static void addArrayToList(Object[] array, List list, int start) {
if (array == null || list == null || array.length == 0) { return;
}
for (int i = 0; i < array.length; i ) {
list.add(start i, array[i]);
}
}
}
引用樓主 johnston678 的帖子: 注意:在eclipse開發工具中,把代碼寫好之後,可以用快捷鍵:CTRL SHIFT F來自動格式化代碼 網友補充:不要依賴於 IDE 的代碼格式化功能,應該在寫的時候就做到規範格式的代碼. 一個層次的縮進推薦採用 4 個空格,而不是 1 個製表符,而 Eclipse 默認格式化是採用 1 個製表符的,可以採用下面的方式更改一下: Window ——> Preferences…… ——> Java ——> Code Style ——> Formatter 點右邊的「Edit……」按鈕,切換到第一個選項卡「Indentation」,在 General settings 組將 Tab policy 由 Table only 改為 Space only,同時把 Indentation size 和 Tab size 改為 4,最后把最上面的 Profile name 取一個名字,名字任意,再點 OK 按鈕就可以了.以後按 Tab 鍵或者 Ctrl Shift F 會自動採用 4 個空格作為一個層次的縮進. 如果採用 EditPlus 編寫代碼的話,也可以更改 Tab 的設置. 另外,對於 HTML、XML、CSS、JavaScript 我也有一些代碼格式方面的建議: 1,HTML、XML 由於層次縮進比較多,建議採用兩個空格作為一層縮進; 2,CSS 和 JavaScript 為了與 HTML 配合,也採用兩個空格作為一層縮進; 3,HTML、XML 的標籤名、屬性稱全部使用小寫字母,HTML 盡量能符合 XHTML 的規範,避免使用 XHTML 不推薦使用的標籤,比如:font、applet 等等; 4,HTML 的屬性值採用雙引號界定; 5,JavaScript 在盡量使用標準的語法、對象等,變數聲明能加上 var.字元串常量統一採用單引號界定 |
[火星人 ] JAVA初學者必看-Java編碼規範已經有584次圍觀