8 程序結構
8.1 程序結構規范
1)程序結構清晰,簡單易懂,單個函數的程序行數不得超過100行。避免使用大文件。如果一個文件裡的代碼超過300~400行,必須考慮將代碼分開到不同類中。避免寫太長的方法。一個典型的方法代碼在1~25行之間。如果一個方法發代碼超過25行,應該考慮將其分解為不同的方法。一個文件應避免超過2000行。
2)打算干什麼,要簡單,直截了當,代碼精簡,避免垃圾程序。
3)盡量使用.Net庫函數和公共函數(無特殊情況不要使用外部方法調用Windows的核心動態鏈接庫API)。
4)不要隨意定義全局變量,盡量使用局部變量。
5)方法名需能看出它作什麼。別使用會引起誤解的名字。如果名字一目了然,就無需用文檔來解釋方法的功能了。
好:
void SavePhoneNumber ( string phoneNumber )
{
// Save the phone number.
}
不好:
// This method will save the phone number.
void SaveData ( string phoneNumber )
{
// Save the phone number.
}
6)程序編碼力求簡潔,結構清晰,避免太多的分支結構及太過於技巧性的程序。
7)避免采用過於復雜的條件測試,避免過多的循環嵌套和條件嵌套。
8)盡量使用.Net庫函數和公共函數(無特殊情況不要使用外部方法調用Windows的核心動態鏈接庫API)。
9)不要隨意定義全局變量,聲明局部變量,並傳遞給方法。不要在方法間共享成員變量。如果在幾個方法間共享一個成員變量,那就很難知道是哪個方法在什麼時候修改了它的值。
10)別在程序中使用固定數值,用常量代替。