java开发手册
目錄
- java開(kāi)發(fā)手冊(cè)
- 命名規(guī)范
- 注釋規(guī)范
- 格式規(guī)范
java開(kāi)發(fā)手冊(cè)
命名規(guī)范
(1) 禁止拼音縮寫(xiě),禁止使用非標(biāo)準(zhǔn)的英文縮寫(xiě)
禁止: DZ[打折] / getPFByName() [評(píng)分](2) 包名全部小寫(xiě)。
com.saury.tools(3) 常量命名全大寫(xiě)。(單詞間用下劃線(xiàn)隔開(kāi)。力求語(yǔ)義表達(dá)完整清楚,不要嫌名字長(zhǎng))
public static final String GAME_COLOR=”RED”;(4) 類(lèi)名與接口名使用UpperCamelCase風(fēng)格,遵從大駝峰命名
Teacher / SudentName(5) 方法名、參數(shù)名、成員變量、局部變量使用lowerCamelCase風(fēng)格,遵從小駝峰命名
userId/ getUserId();注釋規(guī)范
(1) 注釋?xiě)?yīng)該使代碼更加清晰易懂
(2) 類(lèi)、接口、構(gòu)造函數(shù)、方法、全局變量必須添加注釋。字段屬性可以選擇添加簡(jiǎn)單注釋。
(3) 特殊地方必須要添加注釋(典型算法,代碼不明晰處,代碼修改處)
格式規(guī)范
(1) 統(tǒng)一使用IDE自動(dòng)的格式化
(2) 用小括號(hào)限定運(yùn)算優(yōu)先級(jí)
(3) 通過(guò)空行進(jìn)行邏輯分段
總結(jié)
- 上一篇: UILabel添加图片之富文本的简单应用
- 下一篇: 认识星座、八大行星的观察