#### [TOC] ## 與語言無關的命名規則的指導原則 ### 區分變量名與子程序名 變量名以小寫字母開始,如:`variableName` 子程序以大寫字母開始,如:`RoutineName()` ### 區分類和對象 方案1:通過大寫字母開頭區分類型和變量 ``` Widget widget; LongerWidget longerWidget; ``` 方案2:通過全部大寫區分類型和變量 ``` WIDGET widget LONGERWIDGET longerwidget ``` 方案3:通過給類型加“t”前綴區分類型和變量 ``` t_Widget Widget: t_LongerWidget LongerWidget: ``` 方案4:通過給變量加“a”前綴區分類型和變量 ``` Widget aWidget: Longerwidget aLongerWidget: ``` 方案5:通過對變量采用更明確的名字區分類型和變量 ``` Widget employeeWidget: Longerwidget fullEmployeeWidget ``` 方案1缺陷 1.僅依靠大小寫視覺差異太小 2.如果多語言混合編程中,有一種語言大小寫不明感,則無法使用方案1(如:Visual Basic) 方案2缺陷 1.由于歷史原因,在C++和java 總全部字母全大寫表示常量 2.編程語言大小寫不敏感,也會產生與方案1同樣的問題 方案3缺陷 1.適用所有語言,但是不夠美觀 方案4缺陷 1.需要改變每個示例的名字,而不是僅僅修改類名 方案5缺陷 1.需要用費腦子想每個示例的鮮明的名字,并且有時候,類似 Widget,只是一個widget > 本書選用**第五種**,對于不未熟悉規則的人,第五種可以直觀的理解 ### 標識全局變量 在所有全局變量前加g 如:`g_RunningTotal` ### 標識成員變量 添加 `m_`前綴來表明該變量既不是全局變量也不是局部變量 ### 標識類型聲明 添加 `t_` 前綴,如`typedef int t_Num;` ### 標識具名常量 方式一: 添加 `c_`前綴 如:`const int c_MaxAge=100;` 方式二:全大寫,單詞間用下劃線標識`const int MAX_AGE=100;` ### 標識枚舉類型 方式一:添加`e_`前綴或`E_`前綴 方式二:用全大寫標識 ### 格式化命名以提高可讀性 推薦采用 小寫字母開頭的小駝峰寫法 ## 不同語言的規則 ### c的命名規則 1. c和ch是字符變量。 2. i和j是整數下標。 3. n表示某物的數量。 4. p是指針 5. s是字符串 6. 預處理宏全部大寫( ALL CAPS)。這通常也包括 typedef 7. 變量名和子程序名全部小寫(all_lowercase) 8. 下畫線(_)用做分隔符:1 etters in_1 lowercase!要比 lettersinlowercase更 具可讀性 這些都是屬于一般性的、UNⅨX風格或者 Linux風格的C編程規則, ### C++的命名規則 1. i和j是整數下標。 2. p是指針。 3. 常量、 typedef和預處理宏全部大寫(ALL_CAPS) 4. 類和其他類型的名字混合大小寫( MixedUpperAndLowerCase())。 5. 變量名和函數名中的第一個單詞小寫,后續每個單詞的首字母大寫--例 如, `variableorRoutineName`。 6. 不把下畫線用做名字中的分隔符,除非用于全部大寫的名字以及特定的前綴 中(如用于標識全局變量的前綴)。 ## 縮短變量名的一般指導規則 1. 使用標準的縮寫(列在字典中的那些常見縮寫) 2. 去掉所有非前置元音。( commputer變成 cmpt, screen變成scrn, appl變成appl, integer變成 inter。) 3. 去掉虛詞and,or,the等。 4. 使用每個單詞的第一個或前幾個字母 5. 統一地在每個單詞的第一、第二或者第三個(選擇最合適的一個)字母后截 6. 保留每個單詞的第一個和最后一個字母。 7. 使用名字中的每一個重要單詞,最多不超過三個。 8. 去除無用的后綴—ing,ed等。 9. 保留每個音節中最引人注意的發音。 10. 確保不要改變變量的含義 11. 反復使用上述技術,直到你把每個變量名的長度縮減到了8到20個字符,或者達到你所用的編程語言對變量名的限制字符數 ## 在代碼注釋中使用縮寫對照表 此方法雖然已經過時,但在嚴格要求字符限制少于n時,很有效 ``` //********************************************************************** // Translation Table // // Variable Meaning // ------- ------- // XPOS X-Coordinate Position (in meters) // YPOS Y-Coordinate Position (in meters) // NDSCMP Needs Computing (=0 if no computation a needed // =1 if computation is needed) // PTGTTL Point Grand Total // PTVLMX Point Value Maximun // PSCRMX Possible Socre Maximum //********************************************************************** ``` ## 在項目的"標準縮寫" 文檔中說明所有的縮寫 可以用文字處理文檔,電子表格文檔,在很大項目里,可以使用數據庫