Nginx編碼風(fēng)格圖示

特別聲明:本文是在《Nginx開發(fā)從入門到精通》的附錄A 編碼風(fēng)格基礎(chǔ)上補(bǔ)充完善了一些細(xì)節(jié)問題械拍。

一罢绽、基本原則

  • K&R編碼風(fēng)格(偏BSD子類)
  • 每行不能超過80列
  • 不用TAB對齊畴栖,用空格
  • 默認(rèn)對齊單元是4個(gè)空格
  • 除宏定義外颊艳,字母均為小寫肾筐,單詞間用下劃線間隔
  • 使用C方式的注釋寝志,不得使用//形式注釋
  • 中綴運(yùn)算符的前后須空一格娇斑,如3 + 2以及a > 3
  • 逗號后須空一格策添,如foo(a, b, c);
  • if/while/for/switch條件表達(dá)式只有一行時(shí),左花括號與表達(dá)式處于同一行毫缆,表達(dá)式為多行時(shí)唯竹,左花括號獨(dú)占一行

二、風(fēng)格圖示(if/while/for/switch)

  1. 小括號與兩邊字符空一個(gè)空格悔醋,括號內(nèi)表達(dá)式兩邊與括號之間沒有空格
  2. 如果表達(dá)式只有一行摩窃,if/while/for/switch語句的左花括號和關(guān)鍵字在同一行上,和括號之間空一個(gè)空格
  3. else/else if語句之前須空出一行
  4. else/else if關(guān)鍵字和兩個(gè)花括號在同一行上芬骄,且左右空一個(gè)空格
  5. 右花括號與if/while/for/switch關(guān)鍵字對齊




  6. 當(dāng)條件表達(dá)式過長需要折行時(shí)猾愿,邏輯運(yùn)算符須位于下一行的行首,并與同一層次的條件表達(dá)式的第一個(gè)字符對齊
  7. 當(dāng)條件表達(dá)式過長需要折行時(shí)账阻,比較運(yùn)算符須位于下一行的行首蒂秘,并與比較語句的第一個(gè)字符對齊
  8. 當(dāng)條件表達(dá)式為多行時(shí),左花括號須位于單獨(dú)的一行淘太,并與if/while等關(guān)鍵字對齊


  9. 例外情況姻僧,當(dāng)條件表達(dá)式過長時(shí),邏輯運(yùn)算符可以適當(dāng)提前


  10. 例外情況蒲牧,條件表達(dá)式一行剛好80字符撇贺,左花括號可以位于單獨(dú)一行


  11. switch語句中,switch和case關(guān)鍵字上下對齊


  12. for語句表達(dá)式分多行時(shí)冰抢,分成三行松嘶,且每行第一個(gè)字符對齊


  13. 無限循環(huán)語句使用for ( ;; ),分號兩邊都空一格空格

三挎扰、風(fēng)格圖示(函數(shù))

  1. 函數(shù)聲明或定義若一行顯示不下翠订,則函數(shù)原型空4個(gè)空格


  2. 函數(shù)定義時(shí),返回類型及修飾符獨(dú)占一行
  3. 函數(shù)參數(shù)列表過長需要換行時(shí)遵倦,換行后需要空4個(gè)空格
  4. 函數(shù)定義的左花括號獨(dú)占一行


  5. 函數(shù)調(diào)用折行時(shí)尽超,參數(shù)上下對齊

四、風(fēng)格圖示(變量梧躺、結(jié)構(gòu)體)

  1. 在函數(shù)中似谁,相同類型的變量聲明放在一行上
  2. 函數(shù)中變量聲明的類型上下排列按照從短到長的順序。注意燥狰,最下面的變量的類型和名稱間的空格為2-3個(gè)棘脐。一般情況下為2個(gè),這是Nginx中最小的變量聲明中類型和名稱的距離
  3. 變量名稱上下對齊——字母對齊龙致,不包括指針的*號


  4. 結(jié)構(gòu)體內(nèi)變量上下對齊(字母蛀缝,不包括指針的*號)


  5. 結(jié)構(gòu)體數(shù)組的左花括號放在同一行上
  6. 結(jié)構(gòu)體數(shù)組的花括號和內(nèi)容之間空一個(gè)空格


  7. 較大的結(jié)構(gòu)體數(shù)組元素最開始空一行,元素之間也空一行
  8. 元素內(nèi)容上下對齊

五目代、風(fēng)格圖示(其他)

  1. 文件開始的注釋空一行
  2. 較為完整的代碼塊間的距離為空兩行屈梁。如函數(shù)聲明嗤练、函數(shù)定義之間等
  3. 函數(shù)中不同處理邏輯之間可以空一行


  4. 注釋上下對齊


  5. 單行注釋格式為/* something */
  6. 多行注釋的格式為:
/*
 * something
 */
  1. 字符串賦值語句多行時(shí)引號對齊


  2. 賦值語句多行時(shí),邏輯運(yùn)算符與上一行字符對齊
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末在讶,一起剝皮案震驚了整個(gè)濱河市煞抬,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌构哺,老刑警劉巖革答,帶你破解...
    沈念sama閱讀 211,042評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異曙强,居然都是意外死亡残拐,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 89,996評論 2 384
  • 文/潘曉璐 我一進(jìn)店門碟嘴,熙熙樓的掌柜王于貴愁眉苦臉地迎上來溪食,“玉大人,你說我怎么就攤上這事娜扇〈砦郑” “怎么了?”我有些...
    開封第一講書人閱讀 156,674評論 0 345
  • 文/不壞的土叔 我叫張陵雀瓢,是天一觀的道長枢析。 經(jīng)常有香客問我,道長刃麸,這世上最難降的妖魔是什么登疗? 我笑而不...
    開封第一講書人閱讀 56,340評論 1 283
  • 正文 為了忘掉前任,我火速辦了婚禮嫌蚤,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘断傲。我一直安慰自己脱吱,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,404評論 5 384
  • 文/花漫 我一把揭開白布认罩。 她就那樣靜靜地躺著箱蝠,像睡著了一般。 火紅的嫁衣襯著肌膚如雪垦垂。 梳的紋絲不亂的頭發(fā)上宦搬,一...
    開封第一講書人閱讀 49,749評論 1 289
  • 那天,我揣著相機(jī)與錄音劫拗,去河邊找鬼间校。 笑死,一個(gè)胖子當(dāng)著我的面吹牛页慷,可吹牛的內(nèi)容都是我干的憔足。 我是一名探鬼主播胁附,決...
    沈念sama閱讀 38,902評論 3 405
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼滓彰!你這毒婦竟也來了控妻?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,662評論 0 266
  • 序言:老撾萬榮一對情侶失蹤揭绑,失蹤者是張志新(化名)和其女友劉穎弓候,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體他匪,經(jīng)...
    沈念sama閱讀 44,110評論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡菇存,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,451評論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了诚纸。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片撰筷。...
    茶點(diǎn)故事閱讀 38,577評論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖畦徘,靈堂內(nèi)的尸體忽然破棺而出毕籽,到底是詐尸還是另有隱情,我是刑警寧澤井辆,帶...
    沈念sama閱讀 34,258評論 4 328
  • 正文 年R本政府宣布关筒,位于F島的核電站,受9級特大地震影響杯缺,放射性物質(zhì)發(fā)生泄漏蒸播。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,848評論 3 312
  • 文/蒙蒙 一萍肆、第九天 我趴在偏房一處隱蔽的房頂上張望袍榆。 院中可真熱鬧,春花似錦塘揣、人聲如沸包雀。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,726評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽才写。三九已至,卻和暖如春奖蔓,著一層夾襖步出監(jiān)牢的瞬間赞草,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,952評論 1 264
  • 我被黑心中介騙來泰國打工吆鹤, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留厨疙,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,271評論 2 360
  • 正文 我出身青樓疑务,卻偏偏與公主長得像轰异,于是被迫代替她去往敵國和親岖沛。 傳聞我的和親對象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,452評論 2 348

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

  • 第2章 基本語法 2.1 概述 基本句法和變量 語句 JavaScript程序的執(zhí)行單位為行(line)搭独,也就是一...
    悟名先生閱讀 4,131評論 0 13
  • 作者:李旺成 時(shí)間:2016年4月3日 1. 前言 這份文檔參考了 Google Java 編程風(fēng)格規(guī)范和 Goo...
    diygreen閱讀 39,869評論 19 224
  • 86.復(fù)合 Cases 共享相同代碼塊的多個(gè)switch 分支 分支可以合并, 寫在分支后用逗號分開婴削。如果任何模式...
    無灃閱讀 1,354評論 1 5
  • 之前在閱讀營的時(shí)候,聽過大部分的內(nèi)容牙肝,這次再聽依然會有新的想法唉俗,還接收到了新的知識點(diǎn),比如親子閱讀配椭。我把自己的技能...
    小李嘮叨閱讀 367評論 1 0
  • 五月的陽光和煦明媚虫溜,十分適宜出游。于是股缸,我和朋友結(jié)伴來到了浙江省博物館衡楞。浙江省博物館始建于1929年,原名“...
    酷酷噠小太陽閱讀 198評論 0 0