• 命名
• 注釋
• 格式

命名

例程

• 避免容易被主觀解釋的難懂的名稱，如對于例程的 analyzethis()，或者對于變量的 xxk8。這樣的名稱會導(dǎo)致多義性，而不僅僅是抽象。
• 在面向?qū)ο蟮恼Z言中，在類屬性的名稱中包含類名是多余的，如 book.booktitle。而是應(yīng)該使用 book.title。
• 使用動詞-名詞的方法來命名對給定對象執(zhí)行特定操作的例程，如 calculateinvoicetotal()。
• 在允許函數(shù)重載的語言中，所有重載都應(yīng)該執(zhí)行相似的函數(shù)。對于那些不允許函數(shù)重載的語言，建立使相似函數(shù)發(fā)生關(guān)系的命名標(biāo)準(zhǔn)。

變量

• 只要合適，在變量名的末尾追加計算限定符（avg、sum、min、max、index）。
• 在變量名中使用互補(bǔ)對，如 min/max、begin/end 和 open/close。
• 鑒于大多數(shù)名稱都是通過連接若干單詞構(gòu)造的，請使用大小寫混合的格式以簡化它們的閱讀。另外，為了幫助區(qū)分變量和例程，請對例程名稱使用 pascal 大小寫處理 (calculateinvoicetotal)，其中每個單詞的第一個字母都是大寫的。對于變量名，請使用 camel 大小寫處理 (documentformattype)，其中除了第一個單詞外每個單詞的第一個字母都是大寫的。
• 布爾變量名應(yīng)該包含 is，這意味著 yes/no 或 true/false 值，如 fileisfound。
• 在命名狀態(tài)變量時，避免使用諸如 flag 的術(shù)語。狀態(tài)變量不同于布爾變量的地方是它可以具有兩個以上的可能值。不是使用 documentflag，而是使用更具描述性的名稱，如 documentformattype。
• 即使對于可能僅出現(xiàn)在幾個代碼行中的生存期很短的變量，仍然使用有意義的名稱。僅對于短循環(huán)索引使用單字母變量名，如 i 或 j。
• 不要使用原義數(shù)字或原義字符串，如 for i = 1 to 7。而是使用命名常數(shù)，如 for i = 1 to num_days_in_week 以便于維護(hù)和理解。

表

• 在命名表時，用單數(shù)形式表示名稱。例如，使用 employee，而不是 employees。
• 在命名表的列時，不要重復(fù)表的名稱；例如，在名為 employee 的表中避免使用名為 employeelastname 的字段。
• 不要在列的名稱中包含數(shù)據(jù)類型。如果后來有必要更改數(shù)據(jù)類型，這將減少工作量。

microsoft sql server

• 不要給存儲過程加 sp 前綴，這個前綴是為標(biāo)識系統(tǒng)存儲過程保留的。
• 不要給用戶定義的函數(shù)加 fn_ 前綴，這個前綴是為標(biāo)識內(nèi)置函數(shù)保留的。
• 不要給擴(kuò)展存儲過程加 xp_ 前綴，這個前綴是為標(biāo)識系統(tǒng)擴(kuò)展存儲過程保留的。

雜項

• 盡量減少使用縮寫，而是使用以一致方式創(chuàng)建的縮寫。縮寫應(yīng)該只有一個意思；同樣，每個縮寫詞也應(yīng)該只有一個縮寫。例如，如果用 min 作為 minimum 的縮寫，那么在所有地方都應(yīng)這樣做；不要將 min 又用作 minute 的縮寫。
• 在命名函數(shù)時包括返回值的說明，如 getcurrentwindowname()。
• 與過程名一樣，文件和文件夾的名稱也應(yīng)該精確地說明它們的用途。
• 避免對不同的元素重用名稱，如名為 processsales() 的例程和名為 iprocesssales 的變量。
• 在命名元素時避免同音異義詞（如 write 和 right），以防在檢查代碼時發(fā)生混淆。
• 在命名元素時，避免使用普遍拼錯的詞。另外，應(yīng)清楚區(qū)域拼寫之間存在的差異，如 color/colour 和 check/cheque。
• 避免用印刷標(biāo)記來標(biāo)識數(shù)據(jù)類型，如用 $ 代表字符串或用 % 代表整數(shù)。

注釋

• 如果用 c# 進(jìn)行開發(fā)，請使用 xml 文檔功能。有關(guān)更多信息，請參閱：xml 文檔。
• 修改代碼時，總是使代碼周圍的注釋保持最新。
• 在每個例程的開始，提供標(biāo)準(zhǔn)的注釋樣本以指示例程的用途、假設(shè)和限制很有幫助。注釋樣本應(yīng)該是解釋它為什么存在和可以做什么的簡短介紹。
• 避免在代碼行的末尾添加注釋；行尾注釋使代碼更難閱讀。不過在批注變量聲明時，行尾注釋是合適的；在這種情況下，將所有行尾注釋在公共制表位處對齊。
• 避免雜亂的注釋，如一整行星號。而是應(yīng)該使用空白將注釋同代碼分開。
• 避免在塊注釋的周圍加上印刷框。這樣看起來可能很漂亮，但是難于維護(hù)。
• 在部署之前，移除所有臨時或無關(guān)的注釋，以避免在日后的維護(hù)工作中產(chǎn)生混亂。
• 如果需要用注釋來解釋復(fù)雜的代碼節(jié)，請檢查此代碼以確定是否應(yīng)該重寫它。盡一切可能不注釋難以理解的代碼，而應(yīng)該重寫它。盡管一般不應(yīng)該為了使代碼更簡單以便于人們使用而犧牲性能，但必須保持性能和可維護(hù)性之間的平衡。
• 在編寫注釋時使用完整的句子。注釋應(yīng)該闡明代碼，而不應(yīng)該增加多義性。
• 在編寫代碼時就注釋，因為以后很可能沒有時間這樣做。另外，如果有機(jī)會復(fù)查已編寫的代碼，在今天看來很明顯的東西六周以后或許就不明顯了。
• 避免多余的或不適當(dāng)?shù)淖⑨專缬哪牟恢饕膫渥ⅰ?
• 使用注釋來解釋代碼的意圖。它們不應(yīng)作為代碼的聯(lián)機(jī)翻譯。
• 注釋代碼中不十分明顯的任何內(nèi)容。
• 為了防止問題反復(fù)出現(xiàn)，對錯誤修復(fù)和解決方法代碼總是使用注釋，尤其是在團(tuán)隊環(huán)境中。
• 對由循環(huán)和邏輯分支組成的代碼使用注釋。這些是幫助源代碼讀者的主要方面。
• 在整個應(yīng)用程序中，使用具有一致的標(biāo)點和結(jié)構(gòu)的統(tǒng)一樣式來構(gòu)造注釋。
• 用空白將注釋同注釋分隔符分開。在沒有顏色提示的情況下查看注釋時，這樣做會使注釋很明顯且容易被找到。

格式

• 建立標(biāo)準(zhǔn)的縮進(jìn)大小（如四個空格），并一致地使用此標(biāo)準(zhǔn)。用規(guī)定的縮進(jìn)對齊代碼節(jié)。
• 在發(fā)布源代碼的硬拷貝版本時使用 monotype 字體。
• 在括號對對齊的位置垂直對齊左括號和右括號，如：

  for (i = 0; i < 100; i++){   ...}

  
  還可以使用傾斜樣式，即左括號出現(xiàn)在行尾，右括號出現(xiàn)在行首，如：

  for (i = 0; i < 100; i++){   ...}

  
  無論選擇哪種樣式，請在整個源代碼中使用那個樣式。
• 沿邏輯結(jié)構(gòu)行縮進(jìn)代碼。沒有縮進(jìn)，代碼將變得難以理解，如：

  if ... thenif ... then...elseend ifelse...end if

  
  縮進(jìn)代碼會產(chǎn)生出更容易閱讀的代碼，如：

  if ... then   if ... then   ...   else   ...   end ifelse...end if

• 為注釋和代碼建立最大的行長度，以避免不得不滾動源代碼編輯器，并且可以提供整齊的硬拷貝表示形式。
• 在大多數(shù)運(yùn)算符之前和之后使用空格，這樣做時不會改變代碼的意圖。但是，c++ 中使用的指針表示法是一個例外。
• 使用空白為源代碼提供結(jié)構(gòu)線索。這樣做會創(chuàng)建代碼“段”，有助于讀者理解軟件的邏輯分段。
• 當(dāng)一行被分為幾行時，通過將串聯(lián)運(yùn)算符放在每一行的末尾而不是開頭，清楚地表示沒有后面的行是不完整的。
• 只要合適，每一行上放置的語句避免超過一條。例外是 c、c++、c# 或 jscript 中的循環(huán)，如 for (i = 0; i < 100; i++)。
• 編寫 html 時，建立標(biāo)準(zhǔn)的標(biāo)記和屬性格式，如所有標(biāo)記都大寫或所有屬性都小寫。另一種方法是，堅持 xhtml 規(guī)范以確保所有 html 文檔都有效。盡管在創(chuàng)建 web 頁時需折中考慮文件大小，但應(yīng)使用帶引號的屬性值和結(jié)束標(biāo)記以方便維護(hù)。
• 編寫 sql 語句時，對于關(guān)鍵字使用全部大寫，對于數(shù)據(jù)庫元素（如表、列和視圖）使用大小寫混合。
• 在物理文件之間在邏輯上劃分源代碼。
• 將每個主要的 sql 子句放在不同的行上，這樣更容易閱讀和編輯語句，例如：

  select firstname, lastnamefrom customerswhere state = 'wa'

• 將大的復(fù)雜代碼節(jié)分為較小的、易于理解的模塊。