自己總結的C#編碼規範--前言&目錄

來源:互聯網
上載者:User

標籤:style   blog   http   os   io   html   代碼   div   

最近在為公司編寫c#編碼規範,以前對這方面研究不多,只是覺得代碼能夠出自己的意思就可以了。

我參考了以下資料

  1. C# Coding Conventions
  2. NET設計規範約定慣用法與模式(第2版)
  3. 編寫可讀性代碼的藝術
  4. 重構—改善既有代碼的設計
  5. 高效程式員的45個習慣
  6. 代碼整潔之道

發現其實真要寫好一個代碼規範是一件非常難的事情,這取決於規範制定者的經驗,團隊成員的水平,業務的具體需求,項目的複雜度,項目的進度,企業的文化氛圍等等。

而且每次提筆要寫的時候,總是有很多很多的想法想寫進去,可是作為一個規範又不可能太長,要精簡。

 

這是目前打算寫的章節

1.命名規範

1.1 命名規範篇

1.2 命名選擇篇

1.3 特定情境下的命名最佳實務篇

2. 注釋

2.1 注釋約定篇

2.2 不需要的注釋篇

2.3 需要的注釋篇

3. 格式

4. 異常處理

5. 編碼最佳實務 

後續幾天我會陸續的把後續章節寫好,同時也希望大家幫我想想編碼規範還有哪些方面需要覆蓋。

 

整個編碼規範寫完後我會提供給大家一個完整的word文檔。

現在把文章列出來是希望大家一起討論下文檔中是否有不合理的內容,還有哪些內容需要覆蓋。

相關文章

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.