Visual Basic.NET編程標準

前言
第I部分 設計
第1章 創(chuàng)建對象和項目模板
1.1 使用對象模板
1.2 使用項目模板
1.3 編程原則
1.3.1 絕不要在對象模板中對應用程序和組件特有的值進行硬編碼
1.3.2 在對象模板中特別是需修改之處提供廣泛的注釋和任務
第2章 設計模塊和過程
2.1 創(chuàng)建具有很強內(nèi)聚性的模塊
2.2 創(chuàng)建松耦合和高度特定化過程
2.2.1 使所有過程都執(zhí)行特定的功能
2.2.2 盡量提高過程的獨立性
2.2.3 最小化扇入和扇出
2.2.4 盡量按字母表順序排列模塊中的過程
2.3 編程原則
2.3.1 給過程和模塊起一個表意性強的名稱
2.3.2 給每個過程設定惟一的出口
2.3.3 給每個過程定義一個明確的范圍
2.3.4 在過程之間用參數(shù)傳遞數(shù)據(jù)
2.3.5 使用統(tǒng)一和直觀明了的方式調用過程
2.3.6 使用Return語句返回函數(shù)值
2.3.7 在復雜函數(shù)中使用暫存變量
第II部分 約定
第3章 命名約定
3.1 匈牙利表示法
3.2 什么情況下不用匈牙利表示法
3.3 指明變量的數(shù)據(jù)類型
3.4 指明變量的范圍
3.5 其他對象別綴
第4章 使用常量和枚舉
4.1 使用常量
4.1.1 幻數(shù)容易出現(xiàn)數(shù)據(jù)輸入錯誤
4.1.2 幻數(shù)難以更新
4.1.3 常量使代碼更容易閱讀
4.2 使用枚舉
4.2.1 創(chuàng)建自定義枚舉
4.2.2 使用自定義枚舉
4.3 編程原則
4.3.1 給所有常量加上前輟C和范圍指示符
4.3.2 用常量代替幻數(shù)而不必考慮可見范圍
4.3.3 盡可能使用枚舉
4.3.4 參數(shù)接收數(shù)量有限的值時使用枚舉
4.3.5 驗證作為枚舉類型傳遞的值
第5章 變量
5.1 編程原則
5.1.1 定義用途明確的變量
5.1.2 給變量起一個表意性強的名稱
5.1.3 在變量名中混合使用大小寫字母
5.1.4 只對常用變量名或長變量名使用縮寫
5.1.5 使用統(tǒng)一限定詞
5.1.6 使用肯定形式的Boolean變量
5.1.7 顯式聲明變量
5.1.8 用精選的數(shù)據(jù)類型聲明變量
5.1.9 只有在絕對必要時才使用Object數(shù)據(jù)類型
5.1.10 使用Option Strict選項嚴格限制類型
5.1.11 最小化變量可見范圍
5.1.12 盡可能使用初始值設定項
5.1.13 使用與號（＆）連接字符串
5.1.14 用字符串長度屬性判斷字符串是否為空
第III部分 編碼結構
第6章 格式化代碼
6.1 編程原則
6.1.1 不要在同一行中放入多個語句
6.1.2 使用續(xù)行符
6.1.3 縮進連續(xù)行
6.1.4 使用縮進顯示代碼的組織結構
6.1.5 在模塊聲明部分縮進代碼以顯示從屬關系
6.1.6 用空行把相關的語句分組
6.1.7 創(chuàng)建可折疊的代碼區(qū)域以便管理
第7章 注釋代碼
7.1 編程原則
7.1.1 用文字說明代碼的作用
7.1.2 解釋為什么要違背良好的編程風格
7.1.3 在寫代碼前先寫注釋
7.1.4 單色字符注釋行僅用于主要注釋
7.1.5 不要創(chuàng)建注釋框
7.1.6 用撇號表示注釋
7.1.7 增強注釋的可讀性
7.1.8 縮進注釋使之與隨后的語句對齊
7.1.9 給每個過程寫一個注釋頭
7.1.10 用內(nèi)嵌注釋說明代碼進程
7.1.11 用行尾變量來說明變量聲明
第8章 循環(huán)結構
8.1 編程原則
8.1.1 循環(huán)次數(shù)確定時使用For…Next循環(huán)
8.1.2 循環(huán)次數(shù)不確定時使用Do…Loop循環(huán)
8.1.3 用Do…Loop循環(huán)代替While…End While
8.1.4 使用For Each…Next循環(huán)遍歷集合中的成員
第9章 控制代碼流
9.1 編程原則
9.1.1 判斷基于一個條件的值是否為真時使用If…Then…Else分支結構
9.1.2 當把一個非Boolean表達式與多個值進行比較時使用Select Case語句
9.1.3 使用行尾注釋增加嵌套判斷結構的清晰度
9.1.4 格式化表達式以便準確求值和易于理解
9.1.5 僅在別無選擇時才使用GoTo語句
第10章 異常處理
10.1 異常對象
10.2 異常處理程序的類型
10.3 使用Try…Catch…Finally語句編寫異常處理程序
10.3.1 捕獲異常
10.3.2 異常處理程序和調用堆棧
10.4 中央異常處理程序
10.4.1 把異常寫入文本文件
10.5 編程原則
10.5.1 用Try…Catch…Finally處理不可預料的和可預料的異常
10.5.2 處理不可預料的異常時使用統(tǒng)一的格式
10.5.3 永遠不要指責用戶
第IV部分 高級編程
第11章 編程對象
11.1 什么是對象
11.2 垃圾回收
11.3 編程原則
11.3.1 要盡早綁定對象
11.3.2 要盡可能使用.NET對象而不是調用API函數(shù)
11.3.3 公開公共屬性而不是公開公共交量
11.3.4 無論打開什么資源都要關閉它們
11.3.5 使用OverLoads創(chuàng)建名稱相同但參數(shù)列表不同的屬性和方法
11.3.6 為所有對象創(chuàng)建Dispose方法
11.3.7 要盡可能為類創(chuàng)建構造函數(shù)
11.3.8 僅在必要時才在類中添加終結器
11.3.9 僅在必要時才強制執(zhí)行垃圾回收
11.3.10 使用With…End With提高性能和代碼的可讀性
第12章 文件操作
12.1 System.IO
12.1.1 System.IO.File和System.IO.Directory
12.1.2 System.IO.Path
12.2 System.Environment
12.3 編程原則
12.3.1 把所有臨時文件都保存在用戶的Temp文件夾中
12.3.2 用系統(tǒng)指定的臨時文件名保存臨時文件
12.3.3 及時關閉不再需要訪問的文件
12.3.4 決不要在程序中使用硬編碼路徑
12.3.5 使用System.IO.Path來操縱文件路徑
12.3.6 文件的默認保存路徑為用戶的MyDocuments文件夾
12.3.7 將文件添加到用戶最近用過的文檔列表中
12.3.8 刪除重要文件時請求確認
第13章 調試
13.1 從Visual Basic 6到Visual Basic.NET
13.1.1 用數(shù)據(jù)提示查看表達式的值
13.1.2 用Debug.Assert定義斷言
13.2 條件編譯
13.2.1 編寫條件編譯代碼
13.2.2 用項目【屬性頁】對話框設置編譯器常量
13.2.3 用命令行設置編譯器常量
13.3 斷點
13.3.1 設置和刪除斷點
13.3.2 進入中斷模式
13.3.3 使用【斷點】窗口管理斷點
13.3.4 用Stop語句進入中斷模式
13.4 Visual Basic.NET調試窗口
13.4.1 【自動】窗口
13.4.2 【局部變量】窗口
13.4.3 Me窗口
13.4.4 【監(jiān)視】窗口
13.4.5 【快速監(jiān)視】窗口
13.4.6 【命令】窗口
13.4.7 【輸出】窗口
13.4.8 【任務列表】窗口
13.4.9 【模塊】窗口
13.4.10 【內(nèi)存】窗口
13.4.11 【調用堆?！看翱?br />13.5 編程原則
13.5.1 啟動項目時不進行調試而不是刪除或禁用調試代碼
13.5.2 當調用Debug.Assert時不要創(chuàng)建修改數(shù)據(jù)的表達式
13.5.3 斷言目的不明確時要指定自定義斷言文本
13.5.4 盡可能使用Option Strict選項
13.5.5 給全部過程都加上異常處理代碼
13.5.6 在條件編譯的調試代碼中使用固有的DEBUG常量
13.5.7 用斷點來確保復雜的過程得到完全執(zhí)行
13.5.8 盡可能使用斷點而不要使用Stop語句
13.5.9 創(chuàng)建注釋作為TODO任務
第V部分 用戶交互
第14章 界面設計
14.1 設計一致界面的要性
14.2 編程原則
14.2.1 使所有窗體具有一致的外觀和行為
14.2.2 用標準的外觀顯示控件
14.2.3 根據(jù)具體情況使用最好的界面組件
14.2.4 提供可理解并且有意義的菜單
14.2.5 盡可能使用系統(tǒng)顏色
第15章 用戶輸入與通知
15.1 用戶輸入
15.2 通知
15.3 編程原則
15.3.1 確保完整的鍵盤導航與交互
15.3.2 提供直觀一致的鼠標交互
15.3.3 創(chuàng)建有意義且實用的消息框
15.3.4 如果應用程序允許用戶打開并保存很多文件則應用程序應記住用戶所選的路徑
第16章 發(fā)布解決方案
16.1 準備要發(fā)布的項目
16.2 創(chuàng)建自定義安裝程序
16.2.1 添加項目的輸出
16.2.2 定義項目輸出的生成選項
16.2.3 向安裝程序中添加文件
16.2.4 文件屬性
16.2.5 改變【應用程序文件夾】的默認位置
16.2.6 使用目標計算機上的文件夾
16.2.7 改變文件的安裝文件夾
16.2.8 創(chuàng)建快捷方式
16.2.9 在安裝過程中修改注冊表
16.2.10 修改自定義安裝程序的用戶界面
16.2.11 指定配置細節(jié)
16.2.12 指定卸載信息
16.2.13 建立自定義安裝程序
16.3 編程原則
16.3.1 對界面進行拼寫檢查
16.3.2 調整窗體上控件的對齊方式
16.3.3 測試所有窗體的Tab鍵順序
16.3.4 檢查重復的訪問鍵
16.3.5 檢查所有對話框的接受和取消按鈕
16.3.6 檢查消息對話框的格式
16.3.7 確保每一個過程都有異常處理程序
16.3.8 核實所使用第3方組件的版本是否正確
16.3.9 為所有已發(fā)布的程序指定邏輯的根命名空間
16.3.10 對程序進行徹底的測試與調試
16.3.11 檢查條件編譯量
16.3.12 不要將文件安裝到用戶的桌面上
16.3.13 不要將快捷方式直接放在Program Files文件夾中
16.3.14 除非能夠確定所有目標計算機安裝了恰當?shù)腤indows Installer否則應該包含引導程序
16.3.15 將安裝項目命名為“程序名Installer”
16.3.16 為項目設置合適的版本號
16.3.17 為每個已安裝的組件創(chuàng)建一個有意義的圖標
16.3.18 務必將路徑［ProgramFilesFloder］［Manufacturer］＼［ProductName］作為默認的【應用序文件夾】
16.3.19 除非有特殊原因，否則應在【應用程序文件夾】中創(chuàng)建所有自定義文件夾
16.3.20 只在需要時包含調試信息
16.3.21 將所有COM文件的SharedLegacy屬性設置為True
16.3.22 將關鍵文件的Vital屬性設置為True
16.3.23 為安裝程序項目設置合適的生成順序
16.3.24 除非有特殊原因，否則應將創(chuàng)建的所有自定義注冊表鍵值設置為DeleteAtUninstall
第VI部分 團隊項目
第17章 版本管理
17.1 了解程序集
17.2 編程原則
17.2.1 每次編譯程序時遞增版本號
17.2.2 在【關于】對話框中顯示程序的版本號
17.2.3 將組件安裝在與客戶端使用該組件相同的文件夾中
17.2.4 推出組件的新版本時要保持兼容性
17.2.5 修改Readme文件中的內(nèi)容
17.2.6 備份自己的文件
17.2.7 使用Visual SourceSafe維護源代碼的版本
第18章 源代碼管理
18.1 確定團隊開發(fā)所面臨的挑戰(zhàn)
18.2 了解Visual SourceSafe
18.3 設置Visual SourceSafe
18.3.1 創(chuàng)建Visual SourceSafe數(shù)據(jù)庫
18.3.2 打開Visual SourceSafe Database
18.3.3 向Visual SourceSafe數(shù)據(jù)庫中添加用戶
18.3.4 將Visual Basic項目置于Visual SourceSafe的管理之下
18.4 Visual Basic項目與Visual SourceSafe
18.4.1 指定工作文件夾
18.4.2 創(chuàng)建項目的工作副本
18.4.3 通過Visual SourceSafe Explorer簽出文件
18.4.4 從Visual Basic IDE中簽入和簽出文件
18.4.5 向源代碼處于管制中的項目添加新文件
18.4.6 獲得文件的最新版本
18.4.7 比較修訂