2010-05-07 72 views
19

我找不到任何直接適用於我的查詢的問題,所以我將其作爲新問題發佈。如果有任何現有的討論可以幫助我,請指出並解決問題。編碼指南+最佳實踐?

問:

我會做C#編碼規則演示,但它不應該限制編碼標準。

所以我有一個大概的想法,但我認爲我需要解決良好的編程實踐。所以內容會是這樣的。

  1. 基本編碼標準 - 套管,格式化等

  2. 良好做法 - 在其他數據結構一個HashSet使用,字符串VS字符串構建,字符串的不變性,有效地利用它們等

真的,我想添加更多的良好實踐(特別是爲了提高性能。)所以喜歡聽到一些與C#一起使用的良好實踐。有什麼建議麼??? (無需大型描述:)只是想法就足夠了。)

+3

這應該可能是社區wiki。 – 2010-05-07 08:04:55

+1

小心創建專有編碼標準。編碼標準通常用意不錯,但是當它們與微軟公佈的內容相悖時,往往會激怒開發人員。創建一個帶有MSDN鏈接的文檔;) – Jonathan 2010-05-07 12:53:56

+0

一篇寫得最好的指南和技巧文章https://www.codingular.com/2017/05/csharp-coding-style-guidelines-best-practices/ – 2017-05-25 11:16:52

回答

1
  • 基本編碼標準 - 確保它是一致的。即使他們不遵循this document on msdn中規定的慣例。我認爲一致性在這裏非常重要。

  • 單元測試 - 你不能在這裏出錯。

  • 安全性 - 談論確保您傳遞敏感數據的安全性。

  • 性能 - 您知道,我個人認爲,獲取應用程序然後查看性能是我的職責。編寫代碼時,我確實有這個想法,所以最後還是會有一些細微的調音。

8

這裏有幾個技巧:

  1. 使用的FxCop靜態分析。
  2. 使用StyleCop進行編碼樣式驗證。
  3. 由於值類型的不同的語義的,與IDE中的替代顏色提供它們(去工具/選項/環境/字體和顏色/顯示項目和供應用戶類型(枚舉)用戶類型(值類型),值爲#DF7120 [223,113,32])。
  4. 因爲異常往往會在您的代碼中顯示錯誤,所以讓IDE打破所有異常。 (轉至調試/例外... /公共語言運行時例外和檢查投擲)。
  5. 項目設置:禁止不安全的代碼。
  6. 項目設置:威脅警告爲錯誤。
  7. 項目設置:檢查算術上溢/下溢。
  8. 將變量用於單個明確定義的目標。
  9. 請勿使用幻數。
  10. 寫簡短的方法。一個方法應該只包含一個抽象級別。
  11. 一個方法不能太小(20行的方法被認爲是相當大的)。
  12. 一種方法應該保護自己免受不良輸入。
  13. 考慮讓一個類型不可變。
  14. 不要使用編譯指示警告禁用來禁止代碼中的警告。
  15. 不要評論錯誤的代碼:重寫它。
  16. 在代碼中顯式記錄爲什麼你要吞嚥異常。
  17. 請注意串聯字符串的性能影響。
  18. 切勿使用goto語句。
  19. 提前失敗,失敗很快。