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

簡簡單單幾條原則:

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

重點講兩個。

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

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

看起來簡單做起來難叮阅。對于Java程序猿刁品,有幾種必要的方式可以幫助你盡可能的做到這一點:

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

上述方式并不是充分的狈茉,我可能會在以后的開發(fā)中繼續(xù)補充重要的方式夫椭,也可能不會。因為你需要掌握的是如何思考氯庆,而不是記住這些死知識蹭秋。

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

錯誤應(yīng)該盡早被檢測出來仁讨,最好是在編譯時刻

刷題的時候要時刻牢記:

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

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

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

這里的錯誤包括異常丈挟、邏輯錯誤等刁卜。分為兩個方面,發(fā)現(xiàn)曙咽、處理:

  • 發(fā)現(xiàn):要求我們盡早的發(fā)現(xiàn)錯誤蛔趴,最好是編譯期;如果在運行期例朱,就要在處理正常邏輯之前夺脾,盡早的檢測出錯誤。特別的茉继,在開發(fā)期間咧叭,編寫完備的測試用例,盡早發(fā)現(xiàn)邏輯錯誤烁竭。
  • 處理:發(fā)現(xiàn)錯誤還不夠菲茬,我們要處理錯誤。如果是編譯或開發(fā)期間發(fā)生的錯誤派撕,修改代碼即可婉弹;如果是運行期發(fā)生的錯誤,記錄日志终吼、提前退出镀赌、拋出異常都是值得考慮的選擇,選擇當前保證和當前場景下最合適的际跪。

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


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

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市闲延,隨后出現(xiàn)的幾起案子痊剖,更是在濱河造成了極大的恐慌,老刑警劉巖垒玲,帶你破解...
    沈念sama閱讀 217,084評論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件陆馁,死亡現(xiàn)場離奇詭異,居然都是意外死亡侍匙,警方通過查閱死者的電腦和手機氮惯,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,623評論 3 392
  • 文/潘曉璐 我一進店門叮雳,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人妇汗,你說我怎么就攤上這事帘不。” “怎么了杨箭?”我有些...
    開封第一講書人閱讀 163,450評論 0 353
  • 文/不壞的土叔 我叫張陵寞焙,是天一觀的道長。 經(jīng)常有香客問我互婿,道長捣郊,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,322評論 1 293
  • 正文 為了忘掉前任慈参,我火速辦了婚禮呛牲,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘驮配。我一直安慰自己娘扩,他們只是感情好,可當我...
    茶點故事閱讀 67,370評論 6 390
  • 文/花漫 我一把揭開白布壮锻。 她就那樣靜靜地躺著琐旁,像睡著了一般。 火紅的嫁衣襯著肌膚如雪猜绣。 梳的紋絲不亂的頭發(fā)上灰殴,一...
    開封第一講書人閱讀 51,274評論 1 300
  • 那天,我揣著相機與錄音掰邢,去河邊找鬼牺陶。 笑死,一個胖子當著我的面吹牛尸变,可吹牛的內(nèi)容都是我干的义图。 我是一名探鬼主播,決...
    沈念sama閱讀 40,126評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼召烂,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了娃承?” 一聲冷哼從身側(cè)響起奏夫,我...
    開封第一講書人閱讀 38,980評論 0 275
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎历筝,沒想到半個月后酗昼,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,414評論 1 313
  • 正文 獨居荒郊野嶺守林人離奇死亡梳猪,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,599評論 3 334
  • 正文 我和宋清朗相戀三年麻削,在試婚紗的時候發(fā)現(xiàn)自己被綠了蒸痹。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,773評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡呛哟,死狀恐怖叠荠,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情扫责,我是刑警寧澤榛鼎,帶...
    沈念sama閱讀 35,470評論 5 344
  • 正文 年R本政府宣布,位于F島的核電站鳖孤,受9級特大地震影響者娱,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜苏揣,卻給世界環(huán)境...
    茶點故事閱讀 41,080評論 3 327
  • 文/蒙蒙 一黄鳍、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧平匈,春花似錦框沟、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,713評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至弟跑,卻和暖如春灾前,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背孟辑。 一陣腳步聲響...
    開封第一講書人閱讀 32,852評論 1 269
  • 我被黑心中介騙來泰國打工哎甲, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人饲嗽。 一個月前我還...
    沈念sama閱讀 47,865評論 2 370
  • 正文 我出身青樓炭玫,卻偏偏與公主長得像,于是被迫代替她去往敵國和親貌虾。 傳聞我的和親對象是個殘疾皇子吞加,可洞房花燭夜當晚...
    茶點故事閱讀 44,689評論 2 354

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