因為本人在大學的時候雖然老師有提到命名的習慣,但自己沒養成
導致過一段時間後回去看程式碼,都不是能直接了解內容意義。
尤其我之前沒有註解程式碼的情況,基本上我寫超過兩個月程式沒看我就全忘光了
導致我每次寫程式好像從頭打怪開始,後來開始接觸大型專案與別人合作時
命名就沒那麼亂來了。
我基本上命名習慣都是 類別名稱小寫 變數名稱沒超過一個字詞小寫
(有抄我程式碼的應該會有感覺,但我還是常常有換習慣喜歡亂縮寫)
專有名詞和超過一個字詞的命名習慣開頭大寫,而用_這個符號分割
我早先因為很多名稱命名過長,所以我用縮寫來命名,又沒註解真的會忘得很快
今天就來比記一下業界命名的通用習慣。
筆記:
類別 | 方法 | 變數 | 常數 | |
習慣 | 以大寫字母開始,若是遇到複合字的情形,則每個字的首字大寫 | 以小寫字母開始,若是遇到複合字的情形,則第二個字以後的首字大寫 | 以小寫字母開始,若是遇到複合字的情形,則第二個字以後的首字大寫 | 全部大寫字母,若是遇到複合字的情形,則字與字之間以底線(_)相接。 |
好的範例 | NewPlayerClass | setPlayerHP、 getPlayerMP |
strength、intelligent、playerHP |
PI、MAX_HP |
常犯的錯 | player、NP | PH、PM、playerH、playerM | st、igt、php |
circlenumber、limithp |
而註解的習慣用:
- 多行註解以 /** 開始,*/ 作為結束,這有利javadoc自動產生說明文件
@copyright MRcodingRoom
觀看更多文章請點MRcoding筆記
觀看更多文章請點MRcoding筆記