代碼維護規范

Ⅰ 華為技術架構師分享：微服務架構下代碼管理規范

當下對於代碼的管理，主要採用GitLab或GitHub，然而使用git進行代碼管理過程中，一般有四種開發模式，分別為主幹開發主幹發布，主幹開發分支發布，分支開發主幹發布，分支開發分支發布。四種開發模式各有特色，下面將從針對四種開發模式進行一一說明。

但是針對微服務體系下，代碼的管理，一般建議採用分支開發主幹發布。

1. 代碼管理模式

1.1. 主幹開發+主幹發布模式

模式特點：所有的操作都在主幹上進行操作，隨著時間的演進，代碼只有一個版本，任何修改，均體現在主幹上面，開發過程比較簡單。

操作許可權：該種模式對於開發人員與項目經理等在代碼提交方面，許可權相同；

適用場景：該種模式適用於團隊規模較小，業務模型明確，且人員技能較高的開發團隊。

1.2. 主幹開發+分支發布模式

模式特點：所有的操作都在主幹上進行操作，隨著時間的演進，代碼具有多個版本，運行多個版本可並行提供服務。

操作許可權：該種模式對於開發人員與項目經理等在代碼提交方面，許可權相同；

適用場景：該種模式適用於多版本並存，但只維護一個版本的產品，其他版本不進行維護的項目，該種場景較少。

1.3. 分支開發+主幹發布模式

模式特點：所有的代碼提交都在分支上操作，隨著時間的演進，需要構建Release版本時，需要將代碼提交到主幹上面，平常開發都是在分支上進行，好處可保證主幹代碼始終可用。

操作許可權：該種方式開發人員只具有開發分支許可權，無鬧團master許可權，代碼的merge只能由項目經理或有權人完成；

適用場景：該種模式適用於多功能並行開發，按照業務特性或模塊進行在分支閉彎敗進行開發，然後在進行合並後進行Release構建發布，業務場景較復雜，且人員素質層次不齊，需要代碼review。

1.4. 分支開發+分支發布模式

模式特點：所有的代碼提交都在分支上操作，隨著時間的演進，需要構建Release版本時，也是直接在分支上進行構建，各分支獨立演進，與主分支關系不大，是主幹開發主幹發布的一個組合使用。

操作許可權：該種方式開發人員與項目經理一樣，只具有分支上的操作許可權，不具有master許可權。

適用場景：該模式適用於需求群/項目群的方式進行開發，大家公用同一個代碼庫，然後共享部門基礎代碼，然後各分支獨立進行演進。

2. 代碼管理規范

無規矩不成方圓，微服務架構下，代碼的管理一般採用git進行管控，因此，在使用git進行版本控制時，應遵循一些原則及規范。

2.1. 代碼管理原則

代碼管理的原則，用於確保轎顫代碼管理過程中不出現原則性錯誤，出現原則性錯誤，則會出現許多無用的操作，基本原則如下：

2.2. 代碼管理規范

由於微服務一般建議採用分支開發主幹發布，因此，本規范主要針對分支開發主幹發布模式，具體規范如下：

Ⅱ 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 Array(packets, offset); }
public int[] getBytes() { return Array(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.array(r1, 0, r3, 0, r1.length);
System.array(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 (i>0) { i ++ }; // 錯誤, { 和 } 在同一行
if (i>0) {
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 來代替在字元串中使用 。
你不要這樣：
System.out.print(Hello,world! );
要這樣：
System.out.println(Hello,world!);
或者你構造一個帶換行符的字元串，至少要象這樣：
String newline = System.getProperty(line.separator);
System.out.println(Hello world + newline);
PrintStream
PrintStream 已經被不贊成（deprecated）使用，用 PrintWrite 來代替它。

Ⅲ 程序員改代碼規范

代碼書寫規則通常對應用程序敬埋的功能沒有影響，但它們對於改善源代碼的昌稿簡理解是有幫助的。養成良好的習慣對於軟體的開發和維護都是很有益的。

一篇編寫規范的代碼,不僅讓自己維護起來更加方便,也會讓其他讀者覺得賞心悅目~快來看看如下10點

第一點：源代碼文件以文件內容中的最頂層的Java類命名，而且大小寫敏感，文件擴展名為.java，同時，文件的編碼格式統一為UTF-8。

?

第二點：類的命名遵循大駝峰命名法UpperCamelCase，而方法名和變數名的命名遵循小駝峰命名法lowerCamelCase。常量名使用大寫字母表示，單詞之間以耐褲下劃線分隔.jsp的文件名全部小寫。

第三點：一個程序文件最好不要超過2000行。

第四點：不用的代碼和引用刪除.

第五點：請合理運用空行。空行可以用來隔開相對獨立的代碼塊，有利於閱讀和理解。但是不要使用超過一行的空行，對空間，別太奢侈了。

第六點：為不容易理解類變數注釋。注釋代碼段，注釋邏輯選擇。

第七點：對成員方法,不要輕易採用public的成員變數。主要的修飾符有public,private,protected。避免過多的參數列表，盡量控制在5個以內。

?

第八點：原則上關系密切的行應對齊，對齊包括類型、修飾、名稱、參數等各部分對齊。另每一行的長度不應超過屏幕太多，必要時適當換行，換行時盡可能在","處或運算符處，換行後最好以運算符打頭。

第九點：為避免編程時遇到麻煩，請保證在自己類路徑指到的任何地方，每個名字都僅對應一個類。否則，編譯器可能先找到同名的另一個類，並報告出錯消息。

?

第十點：字元串不應該重復，如果多次用到同一字元串，建議將該字元串定義為字元串常量，再引用。

Ⅳ 如何規范自己的代碼編輯方式

對於程序員來說，養成良好的代碼寫作能力是非常重要的。今天，我們就一起來了解一下，規范化的代碼編寫都有哪些要求。希望通過對本文的閱讀，能夠提高大家對於代碼規范的認識扮迅型。

1.保證代碼壓縮後不出錯廳猜

對於大型的JSP項目，一般會在產品發布時對項目包含的所有JSP文件進行壓縮處理，比如可以利用GoogleClosureCompilerService對代碼進行壓縮，新版jQuery已改用這一工具對代碼進行壓縮，這一般會去掉開發時寫的注釋，除去所有空格和換行，甚至可以把原來較長的變數名替換成短且無意義的變數名，這樣做的目的是加快文件的下載速度，同時也減小網站訪問帶來的額外數據流量，另外在代碼保護上也起到了一點點作用，至少壓縮後的代碼即使被還原還是沒那麼容易一下讀懂的。要想代碼能正確通過壓縮，一般要求語句都要以分號正常結束，大括弧也要嚴格結束等，具體還要看壓縮工具的要求。所以如果一開始沒有按標准來做，等壓縮出錯後再回去找錯誤那是浪費時間。

2.保證代碼能通過特定IDE的自動格式化功能

一般較為完善的開發工具(比如AptanaStudio)都有代碼"自動格式"化功能，這一功能幫助實現統一換行、縮進、空格等代碼編排，你可以設置自己喜歡的格式標准，比如左大括弧{是否另起一行。達到這個要求的目的在於方便你的開發團隊成員拿你代碼的一個副本用IDE自動格式化成他喜歡或熟悉的風格進行閱讀。你同事需要閱讀你的代碼，可能是因為你寫的是通用方法，他在其它模塊開發過程中也要使用到，閱讀你的代碼能深入了解方法調用和實現的細節，這是簡單API文檔不能達到的效果。

3.使用標準的文檔注釋

這一要求算是基本的，這有利於在方法調用處看到方法的具體傳參提示，也可以利用配套文檔工具生成html或其它格式的開發文檔供其他團隊成員閱讀，你可以嘗試使用jsdoc-toolkit。如果昌皮你自動生成的API是出自一個開放平台，就像facebook.com應用，那麼你的文檔是給天下所有開發者看的。另外編寫完整注釋，也更方便團隊成員閱讀你的代碼，通過你的參數描述，團隊成員可以很容易知道你編寫的方法傳參與實現細節。當然也方便日後代碼維護，這樣即使再大的項目，過了很長時間後，回去改點東西也就不至於自己都忘記了當時自己寫的代碼是怎麼一回事了。

4.使用規范有意義的變數名

使用規范有意義的變數名可以提高代碼的可讀性，作為大項目開發成員，自己寫的代碼不僅僅要讓別人容易看懂。電腦培訓認為開發大項目，其實每個人寫的代碼量可能都比較大，規范命名，日後自己看回自己的代碼也顯的清晰易懂，比如日後系統升級或新增功能，修改起代碼來也輕松多了。如果到頭發現自己當初寫的代碼現在看不太懂了，那還真是天大的笑話了。