原文:自己總結的C#編碼規范--5.如何寫好注釋篇

本文是讀完前言中提到的幾本書后,結合自身的想法總結出來的如何寫好注釋的一些比較實用的方法。 另外本文是上一篇 注釋篇 的一個補充 如何寫好注釋 避免使用不明確的代詞 有些情況下, it , this 等代詞指代很容易產生歧義,最安全的方式是不要使用將所有可能產生歧義的代詞替換成實際指代的詞。 如: Insert the data into the cache,but check if it s t ...

2014-08-01 16:37 4 2030 推薦指數:

查看詳情

自己總結C#編碼規范--4.注釋

注釋 注釋毫無疑問是讓別人以最快速度了解你代碼的最快途徑,但寫注釋的目的絕不僅僅是"解釋代碼做了什么",更重要的盡量幫助代碼閱讀者對代碼了解的和作者一樣多。 當你寫代碼時,你腦海里會有很多有價值的信息,但當其他人讀你代碼時,這些信息已經丟失,他們所見到的只是眼前 ...

Wed Jul 30 00:31:00 CST 2014 23 7219
自己總結C#編碼規范--1.命名約定

命名約定 我們在命名標識符時(包括參數,常量,變量),應使用單詞的首字母大小寫來區分一個標識符中的多個單詞,如UserName. PascalCasing Pascal ...

Fri Jul 25 02:23:00 CST 2014 15 7167
自己總結C#編碼規范--2.命名選擇

上一文章講了標識符命名的約定,今天講下標識符命名的選擇。 簡單的講,看到一個標識符一定要可以見名知意。 名字一定要能夠表達出標識符的含意 標識符名字必須要表達出該標識符的意義,絕對不可以使用無意義的v1,v2…vn之類的命名。 public static void ...

Sat Jul 26 00:02:00 CST 2014 7 1706
自己總結C#編碼規范--6.格式

格式 格式的統一使用可以使代碼清晰、美觀、方便閱讀。為了不影響編碼效率,在此只作如下規定: 長度 一個文件最好不要超過500行(除IDE自動生成的類)。 一個文件必須只有一個命名空間,嚴禁 ...

Tue Aug 05 00:02:00 CST 2014 5 2477
C# 編碼規范

本文是參考阿里的Java編碼規范修改的C#版本,自整理並編寫,歡迎指正! 編程規約 (一)命名規約 1.【強制】代碼中當且僅當私有成員可以使用下划線開始 反例:public string _name 2.【強制】代碼中的命名嚴禁使用拼音 ...

Wed Apr 05 23:07:00 CST 2017 2 4036
C#編碼規范

記錄 編碼約定 學習過程。 命名空間約定 如果沒有使用using指令,項目也沒有默認導入合適的命名空間,訪問這些命名空間或者類型時,則需要“完全限定名稱”。 如果使用了Using指令,則不需要“完全限定名稱”。 代碼布局約定 不輕易更改 ...

Sun Mar 08 06:37:00 CST 2020 1 721
C# 編碼規范

Pascal命名法:每個單詞首字母均大寫。 Camel命名法:第一個單詞首字母小寫,其余單詞首字母大寫。 類: 1、使用 Pascal 大小寫。 2、用名詞或名詞短語命名類,保證類名清晰,盡量達到望文生義的境界。 3、類名稱盡量少用或不用縮寫,若使用了縮寫一定要在注釋中詳細注明類的用途 ...

Fri Oct 07 23:57:00 CST 2016 0 1859
自己總結C#編碼規范--7.文檔下載 & 總結

今天終於把這一系列的編碼規范寫完了,這個編碼規范算上前面閱讀相關書籍,前前后后總共花了一個月的時間,也算是個人的嘔心瀝血之作了。 本來也沒打算把這個系列寫的這么長,但是在寫的過程中自己搜了相關的網上資料,后來發現網上的c#代碼規范很少,而且僅有的幾份都很泛泛,沒有實際的內容。所以自己就閱讀了相關 ...

Tue Aug 05 17:15:00 CST 2014 38 4961
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM