北大青鳥java培訓：如何規范自己的代碼編輯方式？

對于程序員來說，養成良好的代碼寫作能力是非常重要的。

成都創新互聯是一家專注于做網站、網站設計與策劃設計,獻縣網站建設哪家好?成都創新互聯做網站,專注于網站建設十余年,網設計領域的專業建站公司;建站業務涵蓋:獻縣等地區。獻縣做網站價格咨詢:18982081108

今天，我們就一起來了解一下，規范化的代碼編寫都有哪些要求。

希望通過對本文的閱讀，能夠提高大家對于代碼規范的認識。

1.保證代碼壓縮后不出錯對于大型的JSP項目，一般會在產品發布時對項目包含的所有JSP文件進行壓縮處理，比如可以利用GoogleClosureCompilerService對代碼進行壓縮，新版jQuery已改用這一工具對代碼進行壓縮，這一般會去掉開發時寫的注釋，除去所有空格和換行，甚至可以把原來較長的變量名替換成短且無意義的變量名，這樣做的目的是加快文件的下載速度，同時也減小網站訪問帶來的額外數據流量，另外在代碼保護上也起到了一點點作用，至少壓縮后的代碼即使被還原還是沒那么容易一下讀懂的。

要想代碼能正確通過壓縮，一般要求語句都要以分號正常結束，大括號也要嚴格結束等，具體還要看壓縮工具的要求。

所以如果一開始沒有按標準來做，等壓縮出錯后再回去找錯誤那是浪費時間。

2.保證代碼能通過特定IDE的自動格式化功能一般較為完善的開發工具(比如AptanaStudio)都有代碼"自動格式"化功能，這一功能幫助實現統一換行、縮進、空格等代碼編排，你可以設置自己喜歡的格式標準，比如左大括號{是否另起一行。

達到這個要求的目的在于方便你的開發團隊成員拿你代碼的一個副本用IDE自動格式化成他喜歡或熟悉的風格進行閱讀。

你同事需要閱讀你的代碼，可能是因為你寫的是通用方法，他在其它模塊開發過程中也要使用到，閱讀你的代碼能深入了解方法調用和實現的細節，這是簡單API文檔不能達到的效果。

3.使用標準的文檔注釋這一要求算是基本的，這有利于在方法調用處看到方法的具體傳參提示，也可以利用配套文檔工具生成html或其它格式的開發文檔供其他團隊成員閱讀，你可以嘗試使用jsdoc-toolkit。

如果你自動生成的API是出自一個開放平臺，就像facebook.com應用，那么你的文檔是給天下所有開發者看的。

另外編寫完整注釋，也更方便團隊成員閱讀你的代碼，通過你的參數描述，團隊成員可以很容易知道你編寫的方法傳參與實現細節。

當然也方便日后代碼維護，這樣即使再大的項目，過了很長時間后，回去改點東西也就不至于自己都忘記了當時自己寫的代碼是怎么一回事了。

4.使用規范有意義的變量名使用規范有意義的變量名可以提高代碼的可讀性，作為大項目開發成員，自己寫的代碼不僅僅要讓別人容易看懂。

電腦培訓認為開發大項目，其實每個人寫的代碼量可能都比較大，規范命名，日后自己看回自己的代碼也顯的清晰易懂，比如日后系統升級或新增功能，修改起代碼來也輕松多了。

如果到頭發現自己當初寫的代碼現在看不太懂了，那還真是天大的笑話了。

如何寫出優雅Java編程

一、不要使用魔法數字，盡量定義枚舉、常量、宏：

我常常見到表示各種狀態的數字，0，1，2....，我真的不知道這表示什么含義，如果

你在不在文檔中說明的話，這個東東過幾天連你自己都不知道個一二三了。

二、命名要具有描述力，盡量使用全名而不是自創的縮寫，除非地球人都這么用這個縮寫：

我常常看到一些自創的縮寫，這個縮寫或許只有你自己知道，類名，方法名，參數名

尤其要有好的描述里，局部變量尚可容忍。我寧可容忍超過40個字符的命令，也不愿意

看到只有一兩個字母的命名，當然迭代用的i,j除外。當然命名不要太長，太長說明你的類和

方法要做的事情太多，請你拆分出更多細粒度功能單一的類和方法。

三、同一類東東命名方式盡可能統一，比如類名使用大寫字母開頭的單詞，變量使用

下劃線分割開來的小寫字母單詞，常量使用下滑線分割的開來的大寫字母單詞。不要

交替使用。

四、函數、類功能盡可能單一，不要試圖寫一個萬能/超級函數或者類。

一個類和方法要有單一的職責，這樣的類和方法只做一件事，并且容易把他做好。

1、不要試圖寫一個強大無比的方法。

我常常看到一些試圖寫的多么“精妙”無比多么“強大”的函數，事實上不是什么精妙，而是

代碼的臭味道。精妙強大無比萬能的方法往往你耗費大量精力去設計算法，試圖覆蓋現在的各

種可能，而無法面對將來新的需求，隨著新的需求，你的這個精妙的方法需要的修改并且改起來

極其痛苦。在一次次的痛苦與精妙的演化中，你的方法越來越復雜，并且每一次修改你都會面

臨影響以前功能的風險。這個方法使用者需要小心的處理你的精妙之處，如果沒有精妙傳遞好參

數，那么這個方法再也不精妙了，而是直接廢掉了。

KISS（keep it simple and stupid）原理就是這個道理，你要使你的代碼盡可能簡單，讓人

看到有一目了然的清爽，而不是因為設計了一個精妙無比的萬能方法而沾沾自喜。這里的簡單不是

簡潔的代名字。有時候簡潔是那種傳說的“精妙”的代碼。

2、不要寫做多件事情的方法和類，你做一件事情，你就寫一個對應的方法，不要試圖通過參數來判定各種情況，然后做事情，并且做的事情和你方法描述的不一致。當你發現你的方法名字想不出來好的名字了，或者要加or和and了，那么請你拆分出更多單一的方法。

不要舉一些linux完成多種功能系統調用，這是被迫的，因為系統調用的數量是有限制的，它只有有限的空間來描述系統調用號和系統調用的映射表，不要在應用程序開發中效仿而誤以為優雅強大。我最惡心根據參數，然后一大堆的if..else 和switch..case判斷。

五、不要修改已有的類和方法而是擴展它。

這是程序設計的一個重要原則，開閉原則，在面向對象的語言中尤為重要。在面向過程中主要表現在，不要在一個函數要應對和這個函數相似的一個需求了，就在這個加個if，來修改這個方法，試圖重用和避免重復。而是要把公用的部分抽出來成一個小的功能函數，然后增加一個應對新的類似這個需求的處理方法。在面向對象中，例如使用策略模式、訪問者模式、Extend Object模式。

六、不要重復你自己（DRY）：

程序最怕的是copy,paste，到處是重復的代碼。copy，paste經常被誤以為快速完成需要用的功能的高效方式而被到處使用。你每重復一次，你就得負責保持他們的一致性，你就得在一處增加新的功能時，你就的把這個的功能加到其他地方。還在我剛會寫代碼的時候去了一個小公司，他們的代碼到處是copy，paste的痕跡，當要在現有的功能增加審計功能是，他們開始下命令了，每個人加幾行代碼來做審計，真不知道那么多人寫的審計版本，分散到那么多處，這個審計功能是否可信有用。

避免DRY的方法就是抽象，分離變化。不管是面向對象還是面向過程，分離變化并抽象之是最主要的設計原則。設計模式中的模板方法，我們常用的回調都是我們常用的方法。

我發現越是提供更多回調處理的語言和框架，就越具有靈活性和易用性。ruby語言之所以有如此的威力，主要是因為它提供了更多的回調處理。它可以在動態的給一個類增加方法，這樣可以在超類中定義增加方法的方法，然后再子類調用，子類就具有無比的能力。它的block提供了強大的回調機制，我只要不知道如何處理了我就yield出來，method missing機制更是神秘無比，你可以寫出像find_by_name_and_age,2.days.ago這樣像自然語言一樣易讀的代碼。

七、不要跨越邊界，在適合的地方寫代碼。

在分層的架構中，不要跨越層的邊界。例如web開發的三層架構:

數據訪問層（DAO)、業務層(Service)、表現層。

不要在業務層裸寫SQL來做事情，不要在業務層摻和進來表現層的東東，不要在表現層/控制器中寫業務的東東。既然已經分層了，那么就要好好的遵守它，如果到處跨越邊界的話，那么和不分層沒有什么區別，使得每一層都不倫不類。例如你應該在業務層進行事務管理，而你的控制器到處是業務代碼，那將無法控制。如果你的業務層到處是SQL，我不知道你的DAO存在的意義了。

八、分層的web架構：

DAO層最好按照模型來劃分dao類，如果業務很簡單，也可以將相關的模型合并為一個DAO。

Service層，不要按照DAO和Service一一對應的方式劃分，而是要按照業務的類別和實際情況來劃分。事實上Service層通常是用來處理涉及到多個模型的業務，而涉及到一個模型的業務，常常被放在模型中，這是一種自然而更面向對象的設計方法。只有數據的模型被稱為貧血型模型，這種模型被認為是對面向對象的一種背離，而在模型中放置專有的業務方法，不僅有利于公用，而且模型更具有描述力。

九、關于MVC:

MVC是一種松耦合的設計方案，最容易誤用的就是控制器（c）。控制器只負責調用業務方法，準備好數據供View去展現。而不要把業務和如何展示的東東放在里面。我常常看到有人在控制器中拼html片段和寫一些業務相關的代碼。

十、順便說一下異常的使用。

如果你是使用語言支持異常機制，那么盡可能的使用異常機制和定義好與自己業務相關的異常，而不是通過返回值表示正確和錯誤。如果你使用的語言支持異常機制，請不要寫類linux下c似的代碼形式，每寫一個函數，我就寫一個判斷返回值調用是否成功，嚴重分離了我對核心業務的關注。異常提供了優雅的處理錯誤的方法。

java軟件開發的代碼規范

1、組織與風格

(1).關鍵詞和操作符之間加適當的空格。

(2).相對獨立的程序塊與塊之間加空行

(3).較長的語句、表達式等要分成多行書寫。

(4).劃分出的新行要進行適應的縮進，使排版整齊，語句可讀。

(5).長表達式要在低優先級操作符處劃分新行，操作符放在新行之首。

(6).循環、判斷等語句中若有較長的表達式或語句，則要進行適應的劃分。

(7).若函數或過程中的參數較長，則要進行適當的劃分。

(8).不允許把多個短語句寫在一行中，即一行只寫一條語句。

(9).函數或過程的開始、結構的定義及循環、判斷等語句中的代碼都要采用縮進風格。

注：如果大家有興趣可以到安安DIY創作室博客，有相關說明性的文章和解釋。

2、注解

Java 的語法與 C++ 及為相似，那么，你知道 Java 的注釋有幾種嗎？是兩種？

// 注釋一行

/* ...... */ 注釋若干行

不完全對，除了以上兩種之外，還有第三種，文檔注釋：

/** ...... */ 注釋若干行，并寫入 javadoc 文檔

注釋要簡單明了。

String userName = null; //用戶名

邊寫代碼邊注釋，修改代碼同時修改相應的注釋，以保證注釋與代碼的一致性。

在必要的地方注釋，注釋量要適中。注釋的內容要清楚、明了，含義準確，防止注釋二義性。

保持注釋與其描述的代碼相鄰，即注釋的就近原則。

對代碼的注釋應放在其上方相鄰位置，不可放在下面。對數據結構的注釋應放在其上方相鄰位置，不可放在下面；對結構中的每個域的注釋應放在此域的右方；

同一結構中不同域的注釋要對齊。

變量、常量的注釋應放在其上方相鄰位置或右方。

全局變量要有較詳細的注釋，包括對其功能、取值范圍、哪些函數或過程存取它以及存取時注意事項等的說明。

在每個源文件的頭部要有必要的注釋信息，包括：文件名；版本號；作者；生成日期；模塊功能描述（如功能、主要算法、內部各部分之間的關系、該文件與其它文件關系等）；主要函數或過程清單及本文件歷史修改記錄等。

/**

* Copy Right Information : Neusoft IIT

* Project : eTrain

* JDK version used : jdk1.3.1

* Comments : config path

* Version : 1.01

* Modification history :2003.5.1

* Sr Date Modified By Why What is modified

* 1. 2003.5.2 Kevin Gao new

**/

在每個函數或過程的前面要有必要的注釋信息，包括：函數或過程名稱；功能描述；輸入、輸出及返回值說明；調用關系及被調用關系說明等

/**

* Description :checkout 提款

* @param Hashtable cart info

* @param OrderBean order info

* @return String

*/

public String checkout(Hashtable htCart,

OrderBean orderBean)

throws Exception{

}

javadoc注釋標簽語法

@author 對類的說明 標明開發該類模塊的作者

@version 對類的說明 標明該類模塊的版本

@see 對類、屬性、方法的說明 參考轉向，也就是相關主題

@param 對方法的說明 對方法中某參數的說明

@return 對方法的說明 對方法返回值的說明

@exception 對方法的說明 對方法可能拋出的異常進行說明

3、命名規范

定義這個規范的目的是讓項目中所有的文檔都看起來像一個人寫的，增加可讀性，減少項目組中因為換人而帶來的損失。（這些規范并不是一定要絕對遵守，但是一定要讓程序有良好的可讀性）較短的單詞可通過去掉元音形成縮寫；要不然最后自己寫的代碼自己都看不懂了，那可不行。

較長的單詞可取單詞的頭幾發符的優先級，并用括號明確表達式的操作順序，避免使用默認優先級。

使用匈牙利表示法

Package 的命名

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

package com.neu.util

Class 的命名

Class 的名字必須由大寫字母開頭而其他字母都小寫的單詞組成,對于所有標識符，其中包含的所有單詞都應緊靠在一起，而且大寫中間單詞的首字母。

public class ThisAClassName{}

Class 變量的命名

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

userName , thisAClassMethod

Static Final 變量的命名

static Final 變量的名字應該都大寫，并且指出完整含義。

/**

*DBConfig PATH

**/

public static final String

DB_CONFIG_FILE_PATH =com.neu.etrain.dbconfig;

參數的命名

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

數組的命名

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

byte[] buffer;

而不是：

byte buffer[];

方法的參數

使用有意義的參數命名，如果可能的話，使用和要賦值的字段一樣的名字：

SetCounter(int size){

this.size = size;

}

4、文件樣式

所有的 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 的。

Class

接下來的是類的注釋，一般是用來解釋類的。

/**

* A class representing a set of packet and byte counters

* It is observable to allow it to be watched, but only

* reports changes when the current set is complete

*/

接下來是類定義，包含了在不同的行的 extends 和 implements

public class CounterSet

extends Observable

implements Cloneable

Class Fields

接下來是類的成員變量：

/**

* Packet counters

*/

protected int[] packets;

public 的成員變量必須生成文檔（JavaDoc）。proceted、private和 package 定義的成

員變量如果名字含義明確的話，可以沒有注釋。

存取方法

接下來是類變量的存取的方法。它只是簡單的用來將類的變量賦值獲取值的話，可以簡單的

寫在一行上。

/**

* Get the counters

* @return an array containing the statistical data. This array has been

* freshly allocated and can be modified by the caller.

*/

public int[] getPackets() { return copyArray(packets, offset); }

public int[] getBytes() { return copyArray(bytes, offset); }

public int[] getPackets() { return packets; }

public void setPackets(int[] packets) { this.packets = packets; }

其它的方法不要寫在一行上

構造函數

接下來是構造函數，它應該用遞增的方式寫（比如：參數多的寫在后面）。

訪問類型 (public, private 等.) 和 任何 static, final 或 synchronized 應該在一行

中，并且方法和參數另寫一行，這樣可以使方法和參數更易讀。

public

CounterSet(int size){

this.size = size;

}

克隆方法

如果這個類是可以被克隆的，那么下一步就是 clone 方法：

public

Object clone() {

try {

CounterSet obj = (CounterSet)super.clone();

obj.packets = (int[])packets.clone();

obj.size = size;

return obj;

}catch(CloneNotSupportedException e) {

throw new InternalError(Unexpected CloneNotSUpportedException: +

e.getMessage());

}

}

類方法

下面開始寫類的方法：

/**

* Set the packet counters

* (such as when restoring from a database)

*/

protected final

void setArray(int[] r1, int[] r2, int[] r3, int[] r4)

throws IllegalArgumentException

{

//

// Ensure the arrays are of equal size

//

if (r1.length != r2.length || r1.length != r3.length || r1.length != r4.length)

throw new IllegalArgumentException(Arrays must be of the same size);

System.arraycopy(r1, 0, r3, 0, r1.length);

System.arraycopy(r2, 0, r4, 0, r1.length);

}

toString 方法

無論如何，每一個類都應該定義 toString 方法：

public

String toString() {

String retval = CounterSet: ;

for (int i = 0; i data.length(); i++) {

retval += data.bytes.toString();

retval += data.packets.toString();

}

return retval;

}

}

main 方法

如果main(String[]) 方法已經定義了, 那么它應該寫在類的底部.

5、代碼可讀性

避免使用不易理解的數字，用有意義的標識來替代。

不要使用難懂的技巧性很高的語句。

源程序中關系較為緊密的代碼應盡可能相鄰。

6、代碼性能

在寫代碼的時候，從頭至尾都應該考慮性能問題。這不是說時間都應該浪費在優化代碼上，而是我們時刻應該提醒自己要注意代碼的效率。比如：如果沒有時間來實現一個高效的算法，那么我們應該在文檔中記錄下來，以便在以后有空的時候再來實現她。

不是所有的人都同意在寫代碼的時候應該優化性能這個觀點的，他們認為性能優化的問題應該在項目的后期再去考慮，也就是在程序的輪廓已經實現了以后。

不必要的對象構造

不要在循環中構造和釋放對象

使用 StringBuffer 對象

在處理 String 的時候要盡量使用 StringBuffer 類，StringBuffer 類是構成 String 類的基礎。

String 類將 StringBuffer 類封裝了起來，（以花費更多時間為代價）為開發人員提供了一個安全的接口。當我們在構造字符串的時候，我們應該用 StringBuffer 來實現大部分的工作，當工作完成后將 StringBuffer 對象再轉換為需要的 String 對象。比如：如果有一個字符串必須不斷地在其后添加許多字符來完成構造，那么我們應該使用StringBuffer 對象和她的 append() 方法。如果我們用 String 對象代替StringBuffer 對象的話，會花費許多不必要的創建和釋放對象的 CPU 時間。大家可以來安安DIY創作室一起討論。

避免太多的使用 synchronized 關鍵字避免不必要的使用關鍵字 synchronized，應該在必要的時候再使用她，這是一個避免死鎖的好方法。

7、編程技巧

byte 數組轉換到 characters

為了將 byte 數組轉換到 characters，你可以這么做：

Hello world!.getBytes();

Utility 類

Utility 類（僅僅提供方法的類）應該被申明為抽象的來防止被繼承或被初始化。

初始化

下面的代碼是一種很好的初始化數組的方法：

objectArguments = new Object[] { arguments };

枚舉類型

JAVA 對枚舉的支持不好，但是下面的代碼是一種很有用的模板：

class Colour {

public static final Colour BLACK = new Colour(0, 0, 0);

public static final Colour RED = new Colour(0xFF, 0, 0);

public static final Colour GREEN = new Colour(0, 0xFF, 0);

public static final Colour BLUE = new Colour(0, 0, 0xFF);

public static final Colour WHITE = new Colour(0xFF, 0xFF, 0xFF);

}

這種技術實現了RED, GREEN, BLUE 等可以象其他語言的枚舉類型一樣使用的常量。

他們可以用 '==' 操作符來比較。

但是這樣使用有一個缺陷：如果一個用戶用這樣的方法來創建顏色 BLACK new Colour(0,0,0)

那么這就是另外一個對象，'=='操作符就會產生錯誤。她的 equal() 方法仍然有效。由于這個原因，這個技術的缺陷最好注明在文檔中，或者只在自己的包中使用。

8、編寫格式

代碼樣式

代碼應該用 unix 的格式，而不是 windows 的（比如：回車變成回車+換行）

文檔化

必須用 javadoc 來為類生成文檔。不僅因為它是標準，這也是被各種 java 編譯器都認可的方法。使用 @author 標記是不被推薦的，因為代碼不應該是被個人擁有的。

縮進

縮進應該是每行2個空格. 不要在源文件中保存Tab字符. 在使用不同的源代碼管理工具時Tab字符將因為用戶設置的不同而擴展為不同的寬度.如果你使用 UltrEdit 作為你的 Java 源代碼編輯器的話，你可以通過如下操作來禁止保存Tab字符, 方法是通過 UltrEdit中先設定 Tab 使用的長度室2個空格，然后用 Format|Tabs to Spaces 菜單將 Tab 轉換為空格。

頁寬

頁寬應該設置為80字符. 源代碼一般不會超過這個寬度, 并導致無法完整顯示, 但這一設置也可以靈活調整. 在任何情況下, 超長的語句應該在一個逗號或者一個操作符后折行. 一條語句折行后, 應該比原來的語句再縮進2個字符.

{} 對

{} 中的語句應該單獨作為一行. 例如, 下面的第1行是錯誤的, 第2行是正確的:

if (i0) { i ++ }; // 錯誤, { 和 } 在同一行

if (i0) {

i ++

}; // 正確, { 單獨作為一行

} 語句永遠單獨作為一行.如果 } 語句應該縮進到與其相對應的 { 那一行相對齊的位置。

括號

左括號和后一個字符之間不應該出現空格, 同樣, 右括號和前一個字符之間也不應該出現空格. 下面的例子說明括號和空格的錯誤及正確使用:

CallProc( AParameter ); // 錯誤

CallProc(AParameter); // 正確

不要在語句中使用無意義的括號. 括號只應該為達到某種目的而出現在源代碼中。下面的例子說明錯誤和正確的用法:

if ((I) = 42) { // 錯誤 - 括號毫無意義

if (I == 42) or (J == 42) then // 正確 - 的確需要括號

9、代碼編譯

1.編寫代碼時要注意隨時保存，并定期備份，防止由于斷電、硬盤損壞等原因造成代碼丟失。

2.同一項目組內，最好使用相同的編輯器，并使用相同的設置選項。

3.合理地設計軟件系統目錄，方便開發人員使用。

4.打開編譯器的所有告警開關對程序進行編譯。

5.在同一項目組或產品組中，要統一編譯開關選項。

6.使用工具軟件（如Visual SourceSafe）對代碼版本進行維護。如果大家有不明白的可以到安安DIY創作室留言。

10、可移植性

Borland Jbulider 不喜歡 synchronized 這個關鍵字，如果你的斷點設在這些關鍵字的作用域內的話，調試的時候你會發現的斷點會到處亂跳，讓你不知所措。除非必須，盡量不要使用。

換行

如果需要換行的話，盡量用 println 來代替在字符串中使用\n。

你不要這樣：

System.out.print(Hello,world!\n);

要這樣：

System.out.println(Hello,world!);

或者你構造一個帶換行符的字符串，至少要象這樣：

String newline = System.getProperty(line.separator);

System.out.println(Hello world + newline);

PrintStream

PrintStream 已經被不贊成（deprecated）使用，用 PrintWrite 來代替它。

當前標題：java代碼優雅規范 javagui代碼
文章路徑：http://m.newbst.com/article38/dosjipp.html

成都網站建設公司_創新互聯，為您提供網站設計公司、搜索引擎優化、網站維護、網站內鏈、網站導航、網站營銷

廣告

聲明：本網站發布的內容（圖片、視頻和文字）以用戶投稿、用戶轉載內容為主，如果涉及侵權請盡快告知，我們將會在第一時間刪除。文章觀點不代表本網站立場，如需處理請聯系客服。電話：028-86922220；郵箱：631063699@qq.com。內容未經允許不得轉載，或轉載時需注明來源： 創新互聯