给 C# 开发者的代码审查清单
0x01.確保沒有任何警告（warnings）。
0x02.如果先執(zhí)行Code Analysis（啟用所有Microsoft Rules）再消除所有警告就更好了。
0x03.去掉所有沒有用到的usings。編碼過程中去掉多余代碼是個好習(xí)慣。（參考：msdn）
0x04.在合理的地方檢查對象是否為’null’，避免運行的時候出現(xiàn)Null Reference Exception。
0x05.始終遵循命名規(guī)范。一般而言變量參數(shù)使用駝峰命名法，方法名和類名使用Pascal命名法。（參考：msdn）
0x06.請確保你了解SOLID原則。
根據(jù)維基百科定義：在程序設(shè)計領(lǐng)域，SOLID (單一功能、開閉原則、里氏替換、接口隔離以及依賴反轉(zhuǎn))是由羅伯特·C·馬丁在21世紀(jì)早期引入的記憶術(shù)首字母縮略字，指代了面向?qū)ο缶幊毯兔嫦驅(qū)ο笤O(shè)計的五個基本原則。當(dāng)這些原則被一起應(yīng)用時，它們使得一個程序員開發(fā)一個容易進行軟件維護和擴展的系統(tǒng)變得更加可能。SOLID所包含的原則是通過引發(fā)編程者進行軟件源代碼的代碼重構(gòu)進行軟件的代碼異味清掃，從而使得軟件清晰可讀以及可擴展時可以應(yīng)用的指南。SOLID被典型的應(yīng)用在測試驅(qū)動開發(fā)上，并且是敏捷開發(fā)以及自適應(yīng)軟件開發(fā)的基本原則的重要組成部分。參考：wiki/SOLID_(面向?qū)ο笤O(shè)計)
0x07.代碼可重用性：如果一塊代碼已經(jīng)被使用超過一次，或者你希望將來使用它，請?zhí)崛〕梢粋€方法。將重復(fù)的工作做成通用的方法放在相關(guān)的類中，這樣一旦你完成別人就可以使用了。將常用功能開發(fā)成用戶控件，這樣可以跨項目重用它們。（參考：①、②）
0x08.代碼一致性：比方說，Int32寫成int，String寫成string，應(yīng)該在代碼里保持統(tǒng)一形式。不能一會二寫成int一會兒寫成Int32。
0x09.代碼可讀性：代碼應(yīng)該是可維護的，便于其他開發(fā)者理解。（參考：msdn）
0x10.釋放非托管資源，比如文件I/O，網(wǎng)絡(luò)資源等。一旦使用結(jié)束就應(yīng)該釋放它們。如果你想一旦超出使用范圍就自動釋放對象，可以使用usings將非托管代碼括起來。參考：msdn
0x11.合理實現(xiàn)異常處理(try/catch和finally塊)和異常記錄。參考：msdn
0x12.確保代碼中方法的行數(shù)不要過多，不超過30到40行。
0x13.及時用代碼管理工具check-in/check-out代碼。(比如TFS)參考：codeproject.com
0x14.相互審查代碼：和你的同事交換代碼，實現(xiàn)內(nèi)部審查。
0x15.單元測試：編寫開發(fā)測試用例完成單元測試，確保代碼被送到QA以前，基本測試完成。參考：msdn
0x16.盡量避免for/foreach循環(huán)嵌套和if條件嵌套。
0x17.如果代碼只會使用一次，請使用匿名類型。參考：msdn
0x18.盡量使用LINQ查詢和Lambda表達式，增加可讀性。參考：msdn
0x19.合理使用var、object和dynamic關(guān)鍵字。由于很多開發(fā)者會感到困惑或者知道的很少，會覺得它們有些相似，故而交換使用，這是要避免的。參考：blogs.msdn
0x20.使用訪問限定符(private, public, protected, internal, protected internal)限定每個方法、類或變量的需要范圍。比方說如果一個類只會在程序集內(nèi)使用，那么定義成internal就足夠了。參考：msdn
0x21.在需要保持解耦的地方使用接口，有些設(shè)計模式的出現(xiàn)也是由于接口的使用。參考：msdn
0x22.按照用法和需要將類定義為sealed、static或abstract。參考：msdn
0x23.如果需要多次串聯(lián)，請使用Stringbuilder代替string，這可以節(jié)省堆內(nèi)存。
0x24.檢查是否有不可能執(zhí)行的代碼，如果有，請修改。
0x25.在每個方法前注釋，說明它的用法、輸入類型和返回值類型信息。
0x26.使用類似Silverlight Spy的工具，檢查和操控Silverlight應(yīng)用在運行時對XMAL的渲染，以此來改善效率。這可以在設(shè)計執(zhí)行XAML時，節(jié)省大量退回和來回修改的時間。
0x27.使用filddler工具通過檢查HTTP/網(wǎng)絡(luò)流量和帶寬，來跟蹤web應(yīng)用和服務(wù)的性能。
0x28.如果你想確認(rèn)Visual Studio以外的方法，請使用WCFTestClient.exe工具，或者裝載它的進程到Visual Studio來進行調(diào)試。
0x29.在任何合理的地方使用constants和readonly。參考：?/msdn、msdn
0x30.盡量避免強制轉(zhuǎn)換和類型轉(zhuǎn)換，因為會造成性能損失。參考：msdn
0x31.對于你想提供自定義信息的類，請重載ToString(來自O(shè)bject類)。參考：msdn
0x32.避免直接從其他代碼中ctrl+c/ctrl+v。一直建議還是自己用手敲，即使你已經(jīng)找到相關(guān)代碼。這樣可以鍛煉自己寫代碼能力，還能正確理解那段代碼的用法。最終你永遠(yuǎn)都不會忘記那段代碼。
0x33.保持閱讀書籍和文章的良好習(xí)慣，遵循大神們的實踐指導(dǎo)。（比如微軟專家和一些著名的專家，Martin Fowler, Kent Beck, Jeffrey Ritcher, Ward Cunningham, Scott Hanselman, Scott Guthrie, Donald E Knuth.）
0x34.確認(rèn)代碼是否有內(nèi)存泄漏。如果有，請確保已修正。參考：blogs.msdn.com
0x35.盡可能參加專家們組織的技術(shù)研討會，可以接觸到最新的軟件趨勢、技術(shù)和最佳實踐
0x36.要透徹理解OOP概念，并盡可能在代碼里實現(xiàn)。
0x37.知道項目設(shè)計架構(gòu)，可以從整體上理解程序的執(zhí)行流程。
0x38.采取必要措施阻止避免任何交叉腳本攻擊、SQL注入和其他安全漏洞。
0x39.永遠(yuǎn)記得將保密和敏感信息加密(通過使用好的加密算法)，比如保存到數(shù)據(jù)庫的密碼和保存在web.config文件中的連接字符，要避免被非認(rèn)證的用戶操縱。
0x40.避免對已知類型(原始類型)使用默認(rèn)關(guān)鍵字，比如int, decimal, bool等。多數(shù)情況下，如果不確定是值類型還是引用類型，就使用泛型類型(T)。參考：msdn
0x41.微軟（在代碼分析條例和指導(dǎo)中）并不推薦使用’out’和’ref’，這些關(guān)鍵字是通過引用傳參，請注意，’ref’參數(shù)在傳入被調(diào)用方法之前，應(yīng)當(dāng)在調(diào)用方法中先初始化，但’out’參數(shù)就不是這樣。參考：msdn
總結(jié)
以上是生活随笔為你收集整理的给 C# 开发者的代码审查清单的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
