最近在為公司編寫c#編碼規范,以前對這方面研究不多,只是覺得代碼能夠出自己的意思就可以了。
我參考了以下資料
發現其實真要寫好一個代碼規范是一件非常難的事情,這取決于規范制定者的經驗,團隊成員的水平,業務的具體需求,項目的復雜度,項目的進度,企業的文化氛圍等等。
而且每次提筆要寫的時候,總是有很多很多的想法想寫進去,可是作為一個規范又不可能太長,要精簡。
這是目前打算寫的章節
1.命名規范
1.1 命名約定篇
1.2 命名選擇篇
1.3 特定場景下的命名最佳實踐篇
2. 注釋
2.1 注釋約定篇
2.2 不需要的注釋篇
2.3 需要的注釋篇
2.4 如何寫好注釋
3. 格式
4. 文檔下載 & 總結
后續幾天我會陸續的把后續章節寫好,同時也希望大家幫我想想編碼規范還有哪些方面需要覆蓋。
整個編碼規范寫完后我會提供給大家一個完整的Word文檔。
現在把文章列出來是希望大家一起討論下文檔中是否有不合理的內容,還有哪些內容需要覆蓋。
新聞熱點
疑難解答