一直以來寫程式在命名時總是隨心所至,想怎麼命名就怎麼命名,總是沒有一個規則可言,長期下來寫的程式變多了也就越看越不順眼、或是連自己都忘了當初是為何要如此命名的。在搜尋了一下才發現原來人家是有一定的命名規則,特此記錄一下讓自己也可以更加進步;此篇先寫部份基礎、如有更新會再續加不另開文章。
一、命名規則。
二、符合 JavaDoc 的註解寫法。
- 命名規則:
- 項目名稱全部小寫。
- Class Name 首字母大寫,如果類名由多個單字組成、則每個單字的首字都要大寫。ex: public class MyFirstClass{}
- 變數、方法首字母小寫。如果名稱由多個單字組成,則每個單字的首字母要大寫。ex: public String toString(){}
- 常數全部大寫。ex: public static String COLOR = “red”;
- 不要使用中文或是拼音法命名。
- JavaDoc 的註解寫法:
- 類別註解:
/**
* @author Eric Chen.,CPY
* @version Create Time:2018年3月29日
*
*/
- 方法、屬性、構造的註解:
/**
* 方法的使用說明
*
* @param 參數的使用說明
* @return return的說明
* @throws 拋出異常的說明
*/
- 其他:
//這是個最基本的註解