代碼整潔之道

一怔揩、前言

? ? 1. 你是程序員蔗坯,你想成為更好的程序員。

? ? 2. 永遠(yuǎn)拋不不掉代碼蛛芥,因?yàn)榇a呈現(xiàn)了需求的細(xì)節(jié)提鸟。

? ? 3. 讀與寫花費(fèi)時(shí)間的比例超過10:1。

? ? 4. 代碼質(zhì)量與其整潔度成正比仅淑。

????5. 離開時(shí)要比發(fā)現(xiàn)時(shí)更整潔称勋。

二、代碼整潔之思路

? ? 1. 命名:有意義的命名涯竟,有意義的語境赡鲜,有意義的區(qū)分;可搜索的名稱庐船;類名和對象名應(yīng)該是名詞或名詞短語银酬,如Account、Customer筐钟;方法名應(yīng)當(dāng)是動(dòng)詞或動(dòng)詞短語揩瞪,如postPayment、deletePage篓冲。取技術(shù)性的名稱李破,通常是最靠譜的做法宠哄。

? ? 2. 函數(shù):函數(shù)的規(guī)則是要短小,每個(gè)函數(shù)都只做一件事嗤攻;理想的函數(shù)參數(shù)數(shù)量是零毛嫉,其次是一,再次是二妇菱,三個(gè)或三個(gè)以上考慮封裝為類承粤;函數(shù)和參數(shù)應(yīng)當(dāng)形成一種良好的動(dòng)詞/名稱對形式,如writeFiled(name)恶耽、checkPassword(String userName, String password)密任;控制和消除重復(fù)。

? ? 3. 注釋:需要注釋偷俭,更需要表述正確的注釋浪讳,否則注釋會(huì)誤導(dǎo),以及堅(jiān)持維護(hù)正確的注釋涌萤。

? ? 4. 格式:代碼的可讀性會(huì)對以后可能發(fā)生的修改行為產(chǎn)生重要影響淹遵;垂直格式,設(shè)定每個(gè)方法不超過100行负溪;橫向格式透揣,設(shè)定每行代碼不超過100個(gè)字符

? ? 5.?對象和數(shù)據(jù)結(jié)構(gòu):對象暴露行為川抡,隱藏?cái)?shù)據(jù)辐真;數(shù)據(jù)結(jié)構(gòu)暴露數(shù)據(jù),沒有明顯的行為崖堤。

? ? 6.?類:類應(yīng)該短小侍咱,單一權(quán)責(zé)原則,內(nèi)聚密幔、依賴倒置原則楔脯;系統(tǒng)應(yīng)該由許多短小的類而不是少量巨大的類組成。

? ? 7.?邊界:使用第三方代碼控制不了的代碼胯甩,需要清晰的分割和定義期望測試昧廷;避免代碼過多的了解第三方代碼中的特定信息,以免日后受它控制偎箫。

? ? 8.?單元測試:測試驅(qū)動(dòng)開發(fā)木柬;測試保證和增強(qiáng)了生產(chǎn)代碼的可擴(kuò)展性、可維護(hù)性和可復(fù)用性淹办。

? ? 9.?系統(tǒng):沒必要先做大而全的設(shè)計(jì)弄诲;將系統(tǒng)的構(gòu)造和使用分開。

? ? 10. 迭進(jìn):代碼能工作還不夠娇唯,能工作的代碼經(jīng)常會(huì)崩潰齐遵;盡早改進(jìn)不合理的代碼結(jié)構(gòu)和設(shè)計(jì);?簡單設(shè)計(jì)塔插、重構(gòu)梗摇、不可重復(fù)?

三想许、樣例??

圖3.1


圖3.2


四伶授、代碼整潔之思考

? ? 1. 精神上的緊箍咒。

? ? 2.?初稿也許粗陋無序流纹,經(jīng)過斟酌推敲糜烹,直至達(dá)到心目中的樣子。

? ? 3. 項(xiàng)目時(shí)間緊迫漱凝,也要保持整潔代碼疮蹦。

? ? 4. 堅(jiān)持代碼評審。

? ? 5. 不僅自己茸炒,也要讓其他開發(fā)人員容易讀懂代碼愕乎。

阿里Java開發(fā)規(guī)范



最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市壁公,隨后出現(xiàn)的幾起案子感论,更是在濱河造成了極大的恐慌,老刑警劉巖紊册,帶你破解...
    沈念sama閱讀 207,248評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件比肄,死亡現(xiàn)場離奇詭異,居然都是意外死亡囊陡,警方通過查閱死者的電腦和手機(jī)芳绩,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,681評論 2 381
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來关斜,“玉大人示括,你說我怎么就攤上這事×⌒螅” “怎么了垛膝?”我有些...
    開封第一講書人閱讀 153,443評論 0 344
  • 文/不壞的土叔 我叫張陵,是天一觀的道長丁稀。 經(jīng)常有香客問我吼拥,道長,這世上最難降的妖魔是什么线衫? 我笑而不...
    開封第一講書人閱讀 55,475評論 1 279
  • 正文 為了忘掉前任凿可,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘枯跑。我一直安慰自己惨驶,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,458評論 5 374
  • 文/花漫 我一把揭開白布敛助。 她就那樣靜靜地躺著粗卜,像睡著了一般。 火紅的嫁衣襯著肌膚如雪纳击。 梳的紋絲不亂的頭發(fā)上续扔,一...
    開封第一講書人閱讀 49,185評論 1 284
  • 那天,我揣著相機(jī)與錄音焕数,去河邊找鬼纱昧。 笑死,一個(gè)胖子當(dāng)著我的面吹牛堡赔,可吹牛的內(nèi)容都是我干的识脆。 我是一名探鬼主播,決...
    沈念sama閱讀 38,451評論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼加匈,長吁一口氣:“原來是場噩夢啊……” “哼存璃!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起雕拼,我...
    開封第一講書人閱讀 37,112評論 0 261
  • 序言:老撾萬榮一對情侶失蹤纵东,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后啥寇,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體偎球,經(jīng)...
    沈念sama閱讀 43,609評論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,083評論 2 325
  • 正文 我和宋清朗相戀三年辑甜,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了衰絮。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,163評論 1 334
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡磷醋,死狀恐怖猫牡,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情邓线,我是刑警寧澤淌友,帶...
    沈念sama閱讀 33,803評論 4 323
  • 正文 年R本政府宣布,位于F島的核電站骇陈,受9級特大地震影響震庭,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜你雌,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,357評論 3 307
  • 文/蒙蒙 一器联、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦拨拓、人聲如沸肴颊。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,357評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽苫昌。三九已至,卻和暖如春幸海,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背奥务。 一陣腳步聲響...
    開封第一講書人閱讀 31,590評論 1 261
  • 我被黑心中介騙來泰國打工物独, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人氯葬。 一個(gè)月前我還...
    沈念sama閱讀 45,636評論 2 355
  • 正文 我出身青樓挡篓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親帚称。 傳聞我的和親對象是個(gè)殘疾皇子官研,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,925評論 2 344

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