軟件開發代碼規範的重要性
俗話說無規矩不成方圓，在現實生活中，無論咱們作什麼事都講究規則，軟件開發也同樣，不管你在什麼樣的軟件開發公司，不管你從事安卓軟件開發仍是手機軟件開發，都必需要遵循軟公司的規則，軟件開發的規則，行業的規則；咱們只有遵循這些規則，有一個好的
軟件開發流程，才能一直很好的走下去，纔能有進步，下面我和你們共同探討一下軟件開發的規則，也就是說咱們開發一個軟件須要知足哪些要求；有不中之處還望你們多多指點：(因爲本人重點從事Java軟件開發，因此重點說的是Java軟件開發的規則，大同小異了)
一、代碼組織與風格
(1).關鍵詞和操做符之間加適當的空格。
(2).相對獨立的程序塊與塊之間加空行
(3).較長的語句、表達式等要分紅多行書寫。
(4).劃分出的新行要進行適應的縮進，使排版整齊，語句可讀。
(5).長表達式要在低優先級操做符處劃分新行，操做符放在新行之首。
(6).循環、判斷等語句中如有較長的表達式或語句，則要進行適應的劃分。
(7).若函數或過程當中的參數較長，則要進行適當的劃分。
(8).不容許把多個短語句寫在一行中，即一行只寫一條語句。
(9).函數或過程的開始、結構的定義及循環、判斷等語句中的代碼都要採用縮進風格。
二、軟件開發中的註解
定義這個規範的目的是讓項目中全部的文檔都看起來像一我的寫的，增長可讀性，減小
項目組中由於換人而帶來的損失。（這些規範並非必定要絕對遵照，可是必定要讓程序有
良好的可讀性）。
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 對方法的說明 對方法可能拋出的異常進行說明
三、軟件開發中的命名規範
定 義這個規範的目的是讓項目中全部的文檔都看起來像一我的寫的，增長可讀性，減小項目組中由於換人而帶來的損失。（這些規範並非必定要絕對遵照，可是必定 要讓程序有良好的可讀性）較短的單詞可經過去掉"元音"造成縮寫；要否則最後本身寫的代碼本身都看不懂了，那可不行。
較長的單詞可取單詞的頭幾發符的優先級，並用括號明確表達式的操做順序，避免使用默認優先級。
使用匈牙利表示法
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;
}
四、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 的。
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[]) 方法已經定義了, 那麼它應該寫在類的底部.
五、軟件開發過程當中代碼的可讀性
避免使用不易理解的數字，用有意義的標識來替代。
不要使用難懂的技巧性很高的語句。
源程序中關係較爲緊密的代碼應儘量相鄰。
六、軟件開發過程當中代碼的性能
在寫代碼的時候，從頭到尾都應該考慮性能問題。這不是說時間都應該浪費在優化代碼上，而是咱們時刻應該提醒本身要注意代碼的效率。好比：若是沒有時間來實現一個高效的算法，那麼咱們應該在文檔中記錄下來，以便在之後有空的時候再來實現她。
不是全部的人都贊成在寫代碼的時候應該優化性能這個觀點的，他們認爲性能優化的問題應該在項目的後期再去考慮，也就是在程序的輪廓已經實現了之後。
沒必要要的對象構造
不要在循環中構造和釋放對象
使用 StringBuffer 對象
在處理 String 的時候要儘可能使用 StringBuffer 類，StringBuffer 類是構成 String 類的基礎。
String 類將 StringBuffer 類封裝了起來，（以花費更多時間爲代價）爲開發人員提供了一個安全的接口。當咱們在構造字符串的時候，咱們應該用 StringBuffer 來實現大部分的工做，當工做完成後將 StringBuffer 對象再轉換爲須要的 String 對象。好比：若是有一個字符串必須不斷地在其後添加許多字符來完成構造，那麼咱們應該使用StringBuffer 對象和她的 append() 方法。若是咱們用 String 對象代替StringBuffer 對象的話，會花費許多沒必要要的建立和釋放對象的 CPU 時間。
避免太多的使用 synchronized 關鍵字避免沒必要要的使用關鍵字 synchronized，應該在必要的時候再使用她，這是一個避免死鎖的好方法。
七、軟件開發的編程技巧
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)
一、代碼組織與風格
(1).關鍵詞和操做符之間加適當的空格。
(2).相對獨立的程序塊與塊之間加空行
(3).較長的語句、表達式等要分紅多行書寫。
(4).劃分出的新行要進行適應的縮進，使排版整齊，語句可讀。
(5).長表達式要在低優先級操做符處劃分新行，操做符放在新行之首。
(6).循環、判斷等語句中如有較長的表達式或語句，則要進行適應的劃分。
(7).若函數或過程當中的參數較長，則要進行適當的劃分。
(8).不容許把多個短語句寫在一行中，即一行只寫一條語句。
(9).函數或過程的開始、結構的定義及循環、判斷等語句中的代碼都要採用縮進風格。
二、軟件開發中的註解
定義這個規範的目的是讓項目中全部的文檔都看起來像一我的寫的，增長可讀性，減小
項目組中由於換人而帶來的損失。（這些規範並非必定要絕對遵照，可是必定要讓程序有
良好的可讀性）。
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 對方法的說明 對方法可能拋出的異常進行說明
三、軟件開發中的命名規範
定 義這個規範的目的是讓項目中全部的文檔都看起來像一我的寫的，增長可讀性，減小項目組中由於換人而帶來的損失。（這些規範並非必定要絕對遵照，可是必定 要讓程序有良好的可讀性）較短的單詞可經過去掉"元音"造成縮寫；要否則最後本身寫的代碼本身都看不懂了，那可不行。
較長的單詞可取單詞的頭幾發符的優先級，並用括號明確表達式的操做順序，避免使用默認優先級。
使用匈牙利表示法
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;
}
四、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 的。
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[]) 方法已經定義了, 那麼它應該寫在類的底部.
五、軟件開發過程當中代碼的可讀性
避免使用不易理解的數字，用有意義的標識來替代。
不要使用難懂的技巧性很高的語句。
源程序中關係較爲緊密的代碼應儘量相鄰。
六、軟件開發過程當中代碼的性能
在寫代碼的時候，從頭到尾都應該考慮性能問題。這不是說時間都應該浪費在優化代碼上，而是咱們時刻應該提醒本身要注意代碼的效率。好比：若是沒有時間來實現一個高效的算法，那麼咱們應該在文檔中記錄下來，以便在之後有空的時候再來實現她。
不是全部的人都贊成在寫代碼的時候應該優化性能這個觀點的，他們認爲性能優化的問題應該在項目的後期再去考慮，也就是在程序的輪廓已經實現了之後。
沒必要要的對象構造
不要在循環中構造和釋放對象
使用 StringBuffer 對象
在處理 String 的時候要儘可能使用 StringBuffer 類，StringBuffer 類是構成 String 類的基礎。
String 類將 StringBuffer 類封裝了起來，（以花費更多時間爲代價）爲開發人員提供了一個安全的接口。當咱們在構造字符串的時候，咱們應該用 StringBuffer 來實現大部分的工做，當工做完成後將 StringBuffer 對象再轉換爲須要的 String 對象。好比：若是有一個字符串必須不斷地在其後添加許多字符來完成構造，那麼咱們應該使用StringBuffer 對象和她的 append() 方法。若是咱們用 String 對象代替StringBuffer 對象的話，會花費許多沒必要要的建立和釋放對象的 CPU 時間。
避免太多的使用 synchronized 關鍵字避免沒必要要的使用關鍵字 synchronized，應該在必要的時候再使用她，這是一個避免死鎖的好方法。
七、軟件開發的編程技巧
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() 方法仍然有效。因爲這個緣由，這個技術的缺陷最好註明在文檔中，或者只在本身的包中使用。更詳細的內容能夠參考《軟件開發代碼規範》。 html
相關文章
- 1. 論代碼規範的重要性
- 2. 代碼規範的重要性
- 3. 論軟件開發中命名規範的重要性
- 4. 軟件的開發規範
- 5. iOS軟件代碼規範
- 6. 軟件研發代碼規範
- 7. [ python ] 軟件開發規範
- 8. 軟件開發規範
- 9. Python-軟件開發規範
- 10. 代碼規範的重要性之-爲何谷歌要執行嚴格的代碼編寫規範
- 更多相關文章...
- • Markdown 代碼 - Markdown 教程
- • Web 品質 - 重要的 HTML 元素 - 網站品質教程
- • PHP開發工具
- • IntelliJ IDEA安裝代碼格式化插件
相關標籤/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
歡迎關注本站公眾號,獲取更多信息
相關文章
- 1. 論代碼規範的重要性
- 2. 代碼規範的重要性
- 3. 論軟件開發中命名規範的重要性
- 4. 軟件的開發規範
- 5. iOS軟件代碼規範
- 6. 軟件研發代碼規範
- 7. [ python ] 軟件開發規範
- 8. 軟件開發規範
- 9. Python-軟件開發規範
- 10. 代碼規範的重要性之-爲何谷歌要執行嚴格的代碼編寫規範