5. 函數(shù)聲明

每個函數(shù)前面應該放置一段塊注釋弊决,概要描述該函數(shù)做什么以及(如果不是很清晰)如何使用該函數(shù)窑邦。重要的設計決策討論以及副作用說明也適合放在注釋 中擅威。避免提供那些代碼本身可以清晰提供的信息。

函數(shù)的返回類型應該單獨占據(jù)一行冈钦,(可選的)縮進一個級別郊丛。不用使用默認返回類型int;如果函數(shù)沒有返回值瞧筛,那么將返回類型聲明為void厉熟。如 果返回值需要大段詳細的說明,可以在函數(shù)之前的注釋中描述较幌;否則可以在同一行中對返回類型進行注釋揍瑟。函數(shù)名(以及形式參數(shù)列表)應該被單獨放在一 行,從第一列開始乍炉。目的(返回值)參數(shù)一般放在第一個參數(shù)位置(從左面開始)绢片。所有形式參數(shù)聲明滤馍、局部聲明以及函數(shù)體中的代碼都應該縮進一級。函 數(shù)體的開始括號應該單獨一行底循,放在開始處的第一列巢株。

每個參數(shù)都應該被聲明(不要使用默認類型int)。通常函數(shù)中每個變量的角色都應該被描述清楚熙涤,我們可以在函數(shù)注釋中描述阁苞,或如果每個聲明單獨一 行,我們可以將注釋放在同一行上祠挫。像循環(huán)計數(shù)器"i"那槽,字符串指針"s"以及用于標識字符的整數(shù)類型"c"這些簡單變量都無需注釋。如果一組函數(shù) 都擁有一個相似的參數(shù)或局部變量茸歧,那么在所有函數(shù)中使用同一個名字來標識這個變量是很有益處的(相反倦炒,避免在相關函數(shù)中使用一個名字標識用途不同 的變量)。不同函數(shù)中的相似參數(shù)還應該放在各個參數(shù)列表中的相同位置软瞎。

參數(shù)和局部變量的注釋應該統(tǒng)一縮進以排成一列逢唤。局部變量聲明應用一個空行與函數(shù)語句分隔開來。

當你使用或聲明變長參數(shù)的函數(shù)時要小心涤浇。目前在C中尚沒有真正可移植的方式處理變長參數(shù)鳖藕。最好設計一個使用固定個數(shù)參數(shù)的接口。如果一定要使用變 長參數(shù)只锭,請使用標準庫中的宏來聲明具有變長參數(shù)的函數(shù)著恩。

如果函數(shù)使用了在文件中沒有進行全局聲明的外部變量(或函數(shù)),我們應該在函數(shù)體內部使用extern關鍵字單獨對這些變量進行聲明蜻展。

避免局部聲明覆蓋高級別的聲明喉誊。尤其是,局部變量不應該在嵌套代碼塊中被重聲明纵顾。雖然這在C中是合法的伍茄,但是當使用-h選項時,潛在的沖突可能性 足以讓lint工具發(fā)出抱怨之聲施逾。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末敷矫,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子汉额,更是在濱河造成了極大的恐慌曹仗,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,723評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件蠕搜,死亡現(xiàn)場離奇詭異怎茫,居然都是意外死亡,警方通過查閱死者的電腦和手機妓灌,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,485評論 2 382
  • 文/潘曉璐 我一進店門遭居,熙熙樓的掌柜王于貴愁眉苦臉地迎上來啼器,“玉大人,你說我怎么就攤上這事俱萍《丝牵” “怎么了?”我有些...
    開封第一講書人閱讀 152,998評論 0 344
  • 文/不壞的土叔 我叫張陵枪蘑,是天一觀的道長损谦。 經常有香客問我,道長岳颇,這世上最難降的妖魔是什么照捡? 我笑而不...
    開封第一講書人閱讀 55,323評論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮话侧,結果婚禮上栗精,老公的妹妹穿的比我還像新娘。我一直安慰自己瞻鹏,他們只是感情好悲立,可當我...
    茶點故事閱讀 64,355評論 5 374
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著新博,像睡著了一般薪夕。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上赫悄,一...
    開封第一講書人閱讀 49,079評論 1 285
  • 那天原献,我揣著相機與錄音,去河邊找鬼埂淮。 笑死姑隅,一個胖子當著我的面吹牛,可吹牛的內容都是我干的倔撞。 我是一名探鬼主播粤策,決...
    沈念sama閱讀 38,389評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼误窖!你這毒婦竟也來了?” 一聲冷哼從身側響起秩贰,我...
    開封第一講書人閱讀 37,019評論 0 259
  • 序言:老撾萬榮一對情侶失蹤霹俺,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后毒费,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體丙唧,經...
    沈念sama閱讀 43,519評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 35,971評論 2 325
  • 正文 我和宋清朗相戀三年觅玻,在試婚紗的時候發(fā)現(xiàn)自己被綠了想际。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片培漏。...
    茶點故事閱讀 38,100評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖胡本,靈堂內的尸體忽然破棺而出牌柄,到底是詐尸還是另有隱情,我是刑警寧澤侧甫,帶...
    沈念sama閱讀 33,738評論 4 324
  • 正文 年R本政府宣布珊佣,位于F島的核電站,受9級特大地震影響披粟,放射性物質發(fā)生泄漏咒锻。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,293評論 3 307
  • 文/蒙蒙 一守屉、第九天 我趴在偏房一處隱蔽的房頂上張望惑艇。 院中可真熱鬧,春花似錦拇泛、人聲如沸滨巴。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,289評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽兢卵。三九已至,卻和暖如春绪颖,著一層夾襖步出監(jiān)牢的瞬間秽荤,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,517評論 1 262
  • 我被黑心中介騙來泰國打工柠横, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留窃款,地道東北人。 一個月前我還...
    沈念sama閱讀 45,547評論 2 354
  • 正文 我出身青樓牍氛,卻偏偏與公主長得像晨继,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子搬俊,可洞房花燭夜當晚...
    茶點故事閱讀 42,834評論 2 345

推薦閱讀更多精彩內容

  • 前言 人生苦多紊扬,快來 Kotlin ,快速學習Kotlin唉擂! 什么是Kotlin缨伊? Kotlin 是種靜態(tài)類型編程...
    任半生囂狂閱讀 26,146評論 9 118
  • Spring Cloud為開發(fā)人員提供了快速構建分布式系統(tǒng)中一些常見模式的工具(例如配置管理牡直,服務發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 134,600評論 18 139
  • importUIKit classViewController:UITabBarController{ enumD...
    明哥_Young閱讀 3,776評論 1 10
  • 這兩天《北京胡控,2000萬人在假裝生活》文章刷屏了,原文還沒來得及看,已經就被屏蔽了,可惜了润讥。 不去說原文內容是什么...
    新匠者閱讀 273評論 0 1
  • 我一直信奉一句話:再卑微的一個人,也有做夢的權利盘寡。 我們之所以這么努力楚殿,是因為心中有個不想放棄的東西。還記得你兒時...
    木錦萱閱讀 212評論 0 3