自己總結的C#編碼規范--5.如何寫好注釋篇
本文是讀完前言中提到的幾本書后，結合自身的想法總結出來的如何寫好注釋的一些比較實用的方法。 另外本文是上一篇 注釋篇 的一個補充 如何寫好注釋 避免使用不明確的代詞 有些情況下，"it", "this"等代詞指代很容易產生歧義，最安全的方式是不要使用將所有可能產生歧義 ...
原文：自己總結的C#編碼規范--4.注釋篇
注釋 注釋毫無疑問是讓別人以最快速度了解你代碼的最快途徑，但寫注釋的目的絕不僅僅是 解釋代碼做了什么 ，更重要的盡量幫助代碼閱讀者對代碼了解的和作者一樣多。 當你寫代碼時，你腦海里會有很多有價值的信息，但當其他人讀你代碼時，這些信息已經丟失，他們所見到的只是眼前代碼。 注釋約定 如果IDE提供注釋格式，則盡量使用IDE提供的格式，否則使用 來注釋。類 屬性和方法的注釋在Visual Studio ...
2014-07-29 16:31 23 7219 推薦指數：
相關推薦
c#小灶——4.注釋和代碼規范
為什么要寫注釋？ 早上我寫完了代碼，我和我的朋友們都能看懂，到了晚上，我還能看懂，一周后，就只有上帝能看懂了…… 將來我們寫的代碼量是很大的，代碼又不像我們自然語言這么好理解，可能過段時間我們就不認識自己的代碼了，所以我們要養成寫注釋的好習慣。 團隊合作當中，寫了注釋更容易 ...
自己總結的C#編碼規范--2.命名選擇篇
上一篇文章講了標識符命名的約定，今天講下標識符命名的選擇。 簡單的講，看到一個標識符一定要可以見名知意。 名字一定要能夠表達出標識符的含意 標識符名字必須要表達出該標識符的意義，絕對不可以使用無意義的v1,v2…vn之類的命名。 public static void ...
自己總結的C#編碼規范--6.格式篇
格式 格式的統一使用可以使代碼清晰、美觀、方便閱讀。為了不影響編碼效率，在此只作如下規定： 長度 一個文件最好不要超過500行(除IDE自動生成的類)。 一個文件必須只有一個命名空間，嚴禁 ...
自己總結的C#編碼規范--1.命名約定篇
命名約定 我們在命名標識符時（包括參數，常量，變量），應使用單詞的首字母大小寫來區分一個標識符中的多個單詞，如UserName. PascalCasing Pascal ...
c#編碼注釋
1 目錄 2 前言... 3 2.1 編寫目的... 3 2.2 適用范圍... 4 3 命名規范... 4 3.1 ...
C#編碼規范
Pascal命名法，無特殊情況，擴展名小寫。 文件開始包含類似以下注釋說明 文件功 ...
C#編碼規范
1 規范目的 ……………………………………………………… 3 2 適用范圍 ……………………………………………………… 3 3 代碼注釋 ……………………………………………………… 3 3.1 代碼注釋約定 ...