本文是讀完前言中提到的幾本書后,結合自身的想法總結出來的如何寫好注釋的一些比較實用的方法。 另外本文是上一篇 注釋篇 的一個補充 如何寫好注釋 避免使用不明確的代詞 有些情況下,"it", "this"等代詞指代很容易產生歧義,最安全的方式是不要使用將所有可能產生歧義 ...
今天終於把這一系列的編碼規范寫完了,這個編碼規范算上前面閱讀相關書籍,前前后后總共花了一個月的時間,也算是個人的嘔心瀝血之作了。 本來也沒打算把這個系列寫的這么長,但是在寫的過程中自己搜了相關的網上資料,后來發現網上的c 代碼規范很少,而且僅有的幾份都很泛泛,沒有實際的內容。所以自己就閱讀了相關的書籍,自己結合自己幾年來的開發經驗寫了這份文檔。希望可以幫助那些苦於沒有編碼規范的程序員,也希望所有新 ...
2014-08-05 09:15 38 4961 推薦指數:
本文是讀完前言中提到的幾本書后,結合自身的想法總結出來的如何寫好注釋的一些比較實用的方法。 另外本文是上一篇 注釋篇 的一個補充 如何寫好注釋 避免使用不明確的代詞 有些情況下,"it", "this"等代詞指代很容易產生歧義,最安全的方式是不要使用將所有可能產生歧義 ...
上一篇文章講了標識符命名的約定,今天講下標識符命名的選擇。 簡單的講,看到一個標識符一定要可以見名知意。 名字一定要能夠表達出標識符的含意 標識符名字必須要表達出該標識符的意 ...
格式 格式的統一使用可以使代碼清晰、美觀、方便閱讀。為了不影響編碼效率,在此只作如下規定: 長度 一個文件最好不要超過500行(除IDE自動生成的類)。 一個文件必須只有一個命名空間,嚴禁 ...
命名約定 我們在命名標識符時(包括參數,常量,變量),應使用單詞的首字母大小寫來區分一個標識符中的多個單詞,如UserName. PascalCasing Pascal ...
注釋 注釋毫無疑問是讓別人以最快速度了解你代碼的最快途徑,但寫注釋的目的絕不僅僅是"解釋代碼做了什么",更重要的盡量幫助代碼閱讀者對代碼了解的和作者一樣多。 當你寫代碼時,你腦海里會 ...
1. 命名規范 a) 類 【規則1-1】使用Pascal規則命名類名,即首字母要大寫。 eg: Class Test { ... } 【規則1-2】使用能夠反映類功能的名詞或名詞短語命名類。 【規則1-3】不要使用“I”、“C”、“_”等特定含義前綴。 【規則 ...
.NET開發編程規范 第1章程序的版式 版式雖然不會影響程序的功能,但會影響可讀性。程序的版式追求清晰、美觀,是程序風格的重要構成因素。 可以把程序的版式比喻為"書法"。好的"書法"可讓人對程序一目了然,看得興致勃勃。差的程序"書法"如螃蟹爬行,讓人看得索然無味,更令維護者煩惱有加 ...
1 規范目的 ……………………………………………………… 3 2 適用范圍 ……………………………………………………… 3 3 代碼注釋 ……………………………………………………… 3 3.1 代碼注釋約定 ...