代碼整潔(學(xué)習(xí)筆記)

軟件開發(fā)中的 5S 原則:

  • 整理:命名的規(guī)范
  • 整頓:把你的代碼放在它應(yīng)該在的地方
  • 清楚:整潔代碼
  • 清潔:代碼風(fēng)格、實踐手段
  • 身美:不斷改進(jìn)

有意義的命名

  • 變量名米碰、方法名:使用小駝峰法 --- 除第一個單詞之外晦毙,其他單詞首字母大寫
eg:
var myStudents;
function getStudentById(){}
  • 類名:使用大駝峰法 --- 所有單詞的首字母都大寫
eg:
class BaseUser{}

好的命名遵循下列的規(guī)范:

  • 名副其實:不需要被注釋也應(yīng)該被理解涣雕、看懂载佳。怎么用橄务、做什么事、為什么存在
  • 避免誤導(dǎo):(I 颗管、O)陷遮,這到底是 I 還是 1,是 O 還是 0;(傻傻分不清)
  • 做有意義的區(qū)分:
    不要使用 a1垦江、a2拷呆、a3
    不要說廢話(student 就不要再寫成 studentInfo 或者 studentData 了)
  • 使用讀得出來的名稱
  • 使用可搜索的名稱:不要使用硬編碼,盡量使用常量替代
  • 一致的命名規(guī)則:比如查找都用 find**
  • 不要使用雙關(guān)語

明了的函數(shù)

  • 短小
  • 每一個函數(shù)/方法應(yīng)該只干一件
  • 函數(shù)參數(shù):
    一元參數(shù):有輸入應(yīng)該也有輸出
    二元參數(shù):盡量不要使用疫粥,除非參數(shù)是有序組成的(new Point(x,y))
    如果參數(shù)個數(shù)超過兩個茬斧,考慮下把參數(shù)封裝一下在傳過去
  • 別重復(fù)自己

注釋

法律信息
提供信息的注釋(時間格式...)
對意圖的解釋
警告
TODO
公共 API

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市梗逮,隨后出現(xiàn)的幾起案子项秉,更是在濱河造成了極大的恐慌,老刑警劉巖慷彤,帶你破解...
    沈念sama閱讀 206,968評論 6 482
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件娄蔼,死亡現(xiàn)場離奇詭異,居然都是意外死亡底哗,警方通過查閱死者的電腦和手機(jī)岁诉,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,601評論 2 382
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來跋选,“玉大人涕癣,你說我怎么就攤上這事∏氨辏” “怎么了坠韩?”我有些...
    開封第一講書人閱讀 153,220評論 0 344
  • 文/不壞的土叔 我叫張陵,是天一觀的道長炼列。 經(jīng)常有香客問我只搁,道長,這世上最難降的妖魔是什么俭尖? 我笑而不...
    開封第一講書人閱讀 55,416評論 1 279
  • 正文 為了忘掉前任氢惋,我火速辦了婚禮,結(jié)果婚禮上稽犁,老公的妹妹穿的比我還像新娘焰望。我一直安慰自己,他們只是感情好缭付,可當(dāng)我...
    茶點故事閱讀 64,425評論 5 374
  • 文/花漫 我一把揭開白布柿估。 她就那樣靜靜地躺著循未,像睡著了一般陷猫。 火紅的嫁衣襯著肌膚如雪秫舌。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,144評論 1 285
  • 那天绣檬,我揣著相機(jī)與錄音足陨,去河邊找鬼。 笑死娇未,一個胖子當(dāng)著我的面吹牛墨缘,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播零抬,決...
    沈念sama閱讀 38,432評論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼镊讼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了平夜?” 一聲冷哼從身側(cè)響起蝶棋,我...
    開封第一講書人閱讀 37,088評論 0 261
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎忽妒,沒想到半個月后玩裙,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,586評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡段直,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,028評論 2 325
  • 正文 我和宋清朗相戀三年吃溅,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片鸯檬。...
    茶點故事閱讀 38,137評論 1 334
  • 序言:一個原本活蹦亂跳的男人離奇死亡决侈,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出喧务,到底是詐尸還是另有隱情颜及,我是刑警寧澤,帶...
    沈念sama閱讀 33,783評論 4 324
  • 正文 年R本政府宣布蹂楣,位于F島的核電站俏站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏痊土。R本人自食惡果不足惜肄扎,卻給世界環(huán)境...
    茶點故事閱讀 39,343評論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望赁酝。 院中可真熱鬧犯祠,春花似錦、人聲如沸酌呆。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,333評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽隙袁。三九已至痰娱,卻和暖如春弃榨,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背梨睁。 一陣腳步聲響...
    開封第一講書人閱讀 31,559評論 1 262
  • 我被黑心中介騙來泰國打工鲸睛, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人坡贺。 一個月前我還...
    沈念sama閱讀 45,595評論 2 355
  • 正文 我出身青樓官辈,卻偏偏與公主長得像,于是被迫代替她去往敵國和親遍坟。 傳聞我的和親對象是個殘疾皇子拳亿,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 42,901評論 2 345

推薦閱讀更多精彩內(nèi)容

  • iOS編程規(guī)范0規(guī)范 0.1前言 為??高產(chǎn)品代碼質(zhì)量,指導(dǎo)廣大軟件開發(fā)人員編寫出簡潔、可維護(hù)愿伴、可靠风瘦、可 測試、高效...
    iOS行者閱讀 4,435評論 21 35
  • 推薦文章:禪與 Objective-C 編程藝 前言 為??高產(chǎn)品代碼質(zhì)量,指導(dǎo)廣大軟件開發(fā)人員編寫出簡潔公般、可維護(hù)万搔、...
    WolfTin閱讀 2,749評論 0 1
  • 該喝的酒多喝兩杯酒精教會你語言和行動說話開始飄離地心在空中變換著色彩 遺忘一顆巨大的石頭讓它緩緩沉入大海來來往往的...
    無法登陸閱讀 199評論 0 2
  • 住在海邊最大的好處就是一年四季可以吃到應(yīng)季的海鮮瞬雹,而四季中海鮮最為豐盛的季節(jié)恰恰就是在深秋時節(jié),魚兒蝦蟹正肥刽虹。 身...
    黑白無閱讀 682評論 5 9
  • 我害怕啊 我害怕遲早被這個世俗打敗 我害怕年齡越來越大酗捌,我害怕我碌碌無為 我害怕我早早走上婚姻再也不提愛...
    也有一個林夕夢閱讀 243評論 0 1