編寫可讀性的代碼

命名

  1. 避免泛化詞
    所有數(shù)據(jù)都叫 data -> PersonalInfo ? ImageContent ?
  2. 增加信息量
    帶上單位 delay -> delayMS , size->sizeMB
    包含必要的解釋 days->daysSinceLastUpdate
  3. 用的詞要有效
    converToString -> toString
    有歧義的詞
    result = filter(objects, "year"<="2016")
    filter是要保留select還是排除exclude
  4. 符合慣例
    約定俗成
    循環(huán)變量:i, j, k
    表示范圍:[begin, end) [first, last]
    noSurprise! 只表達簡單的操作、無副作用拜轨,成對的API參數(shù)含義一致

注釋

  1. 不加沒有價值的注釋,如果變量名就可以說明允青,就不必要加注釋
  2. 為常量加注釋橄碾,為什么取這個值
  3. 解釋Hack
  4. 解釋可能出現(xiàn)的風(fēng)險: 非線程安全

邏輯:表達式

  1. 變量與常量:變量在左,常量在右
    變量與變量:小于號原則颠锉,與數(shù)軸一致
  2. 臨時變量+好的命名

if (lhs.min <= rhs.max && lhs.max<=rhs.min) {
operations
}
bool isOverlay = 表達式;
if (isOverlay) {
operations
}

結(jié)構(gòu):減少嵌套法牲,善用空行

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市琼掠,隨后出現(xiàn)的幾起案子拒垃,更是在濱河造成了極大的恐慌,老刑警劉巖瓷蛙,帶你破解...
    沈念sama閱讀 217,907評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件悼瓮,死亡現(xiàn)場離奇詭異,居然都是意外死亡艰猬,警方通過查閱死者的電腦和手機横堡,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,987評論 3 395
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來冠桃,“玉大人翅萤,你說我怎么就攤上這事。” “怎么了套么?”我有些...
    開封第一講書人閱讀 164,298評論 0 354
  • 文/不壞的土叔 我叫張陵培己,是天一觀的道長。 經(jīng)常有香客問我胚泌,道長省咨,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,586評論 1 293
  • 正文 為了忘掉前任玷室,我火速辦了婚禮零蓉,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘穷缤。我一直安慰自己敌蜂,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 67,633評論 6 392
  • 文/花漫 我一把揭開白布津肛。 她就那樣靜靜地躺著章喉,像睡著了一般。 火紅的嫁衣襯著肌膚如雪身坐。 梳的紋絲不亂的頭發(fā)上秸脱,一...
    開封第一講書人閱讀 51,488評論 1 302
  • 那天,我揣著相機與錄音部蛇,去河邊找鬼摊唇。 笑死,一個胖子當(dāng)著我的面吹牛涯鲁,可吹牛的內(nèi)容都是我干的巷查。 我是一名探鬼主播,決...
    沈念sama閱讀 40,275評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼抹腿,長吁一口氣:“原來是場噩夢啊……” “哼吮便!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起幢踏,我...
    開封第一講書人閱讀 39,176評論 0 276
  • 序言:老撾萬榮一對情侶失蹤髓需,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后房蝉,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體僚匆,經(jīng)...
    沈念sama閱讀 45,619評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,819評論 3 336
  • 正文 我和宋清朗相戀三年搭幻,在試婚紗的時候發(fā)現(xiàn)自己被綠了咧擂。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,932評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡檀蹋,死狀恐怖松申,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤贸桶,帶...
    沈念sama閱讀 35,655評論 5 346
  • 正文 年R本政府宣布舅逸,位于F島的核電站,受9級特大地震影響皇筛,放射性物質(zhì)發(fā)生泄漏琉历。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,265評論 3 329
  • 文/蒙蒙 一水醋、第九天 我趴在偏房一處隱蔽的房頂上張望旗笔。 院中可真熱鬧,春花似錦拄踪、人聲如沸蝇恶。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,871評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽撮弧。三九已至,卻和暖如春耀盗,著一層夾襖步出監(jiān)牢的瞬間想虎,已是汗流浹背卦尊。 一陣腳步聲響...
    開封第一講書人閱讀 32,994評論 1 269
  • 我被黑心中介騙來泰國打工叛拷, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人岂却。 一個月前我還...
    沈念sama閱讀 48,095評論 3 370
  • 正文 我出身青樓忿薇,卻偏偏與公主長得像,于是被迫代替她去往敵國和親躏哩。 傳聞我的和親對象是個殘疾皇子署浩,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,884評論 2 354

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