程序猿應(yīng)該記住的幾條基本規(guī)則

簡(jiǎn)簡(jiǎn)單單幾條原則:

  1. 模塊的用戶永遠(yuǎn)也不應(yīng)該被模塊的行為所迷惑
  2. 模塊要盡可能小,但又不能太小
  3. 代碼應(yīng)該被重用,而不是被拷貝
  4. 模塊之間的依賴性應(yīng)該盡可能降到最小
  5. 錯(cuò)誤應(yīng)該盡早被檢測(cè)出來,最好是在編譯時(shí)刻

重點(diǎn)講兩個(gè)。

模塊的用戶永遠(yuǎn)也不應(yīng)該被模塊的行為所迷惑

最簡(jiǎn)單的方式是寫下多且準(zhǔn)確的注釋,不過我相信大部分很難做到“準(zhǔn)確”。我習(xí)慣引用濤神的話,將該條規(guī)則表述為要求“代碼能夠自解釋”。

看起來簡(jiǎn)單做起來難。對(duì)于Java程序猿,有幾種必要的方式可以幫助你盡可能的做到這一點(diǎn):

  • 除了對(duì)外公布的API和部分重要模塊,要求自己不加任何注釋
  • 使用清晰明確的命名,包括變量、函數(shù)、類
  • 被確定命名的類、函數(shù)、變量,其功能應(yīng)單一、確定
  • 使用的時(shí)候再聲明/創(chuàng)建,并盡可能進(jìn)行顯示的初始化
  • 嚴(yán)格明確對(duì)外保證的邊界,將精力放在保證公開接口,而不是私有實(shí)現(xiàn)
  • 恰當(dāng)?shù)氖褂卯惓:腿罩?/strong>,不要用日志代替所有異常,但或許很多ERROR級(jí)別的日志都可以用異常來代替
  • 雖然與原則2相悖,但如果合并模塊不會(huì)使系統(tǒng)變的難以理解,為了簡(jiǎn)化系統(tǒng)結(jié)構(gòu)我們建議合并部分模塊
  • 除非對(duì)外發(fā)布后不可更改(比如java.util.Set接口),否則,在能保持良好系統(tǒng)結(jié)構(gòu)的前提下,不要面向未來開發(fā)(這一點(diǎn)可能很難接受,不過想想什么時(shí)候才應(yīng)該應(yīng)用設(shè)計(jì)模式呢?什么時(shí)候時(shí)候才應(yīng)該優(yōu)化性能呢?有需要的時(shí)候。如果現(xiàn)在不需要,就不要面向未來開發(fā)。)

上述方式并不是充分的,我可能會(huì)在以后的開發(fā)中繼續(xù)補(bǔ)充重要的方式,也可能不會(huì)。因?yàn)?strong>你需要掌握的是如何思考,而不是記住這些死知識(shí)

上述原則部分參考自Google Java Style Guide,建議二者結(jié)合閱讀。

錯(cuò)誤應(yīng)該盡早被檢測(cè)出來,最好是在編譯時(shí)刻

刷題的時(shí)候要時(shí)刻牢記:

如果可能,盡早的處理邊界條件

對(duì)于工程開發(fā),可以改編如下:

如果可能,盡早的發(fā)現(xiàn)并處理錯(cuò)誤

這里的錯(cuò)誤包括異常、邏輯錯(cuò)誤等。分為兩個(gè)方面,發(fā)現(xiàn)、處理:

  • 發(fā)現(xiàn):要求我們盡早的發(fā)現(xiàn)錯(cuò)誤,最好是編譯期;如果在運(yùn)行期,就要在處理正常邏輯之前,盡早的檢測(cè)出錯(cuò)誤。特別的,在開發(fā)期間,編寫完備的測(cè)試用例,盡早發(fā)現(xiàn)邏輯錯(cuò)誤。
  • 處理:發(fā)現(xiàn)錯(cuò)誤還不夠,我們要處理錯(cuò)誤。如果是編譯或開發(fā)期間發(fā)生的錯(cuò)誤,修改代碼即可;如果是運(yùn)行期發(fā)生的錯(cuò)誤,記錄日志、提前退出、拋出異常都是值得考慮的選擇,選擇當(dāng)前保證和當(dāng)前場(chǎng)景下最合適的。

該原則要和原則1結(jié)合起來(任何原則都要和原則1結(jié)合),所以記得讓你發(fā)現(xiàn)、處理錯(cuò)誤的代碼也是自解釋的。


本文鏈接:程序猿應(yīng)該記住的幾條基本規(guī)則
作者:猴子007
出處:https://monkeysayhi.github.io
本文基于 知識(shí)共享署名-相同方式共享 4.0 國(guó)際許可協(xié)議發(fā)布,歡迎轉(zhuǎn)載,演繹或用于商業(yè)目的,但是必須保留本文的署名及鏈接。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,197評(píng)論 6 531
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,415評(píng)論 3 415
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,104評(píng)論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我,道長(zhǎng),這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,884評(píng)論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 71,647評(píng)論 6 408
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,130評(píng)論 1 323
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,208評(píng)論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,366評(píng)論 0 288
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,887評(píng)論 1 334
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 40,737評(píng)論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 42,939評(píng)論 1 369
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,478評(píng)論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,174評(píng)論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,586評(píng)論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,827評(píng)論 1 283
  • 我被黑心中介騙來泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 51,608評(píng)論 3 390
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 47,914評(píng)論 2 372

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