神乎其技,惟 C 程序;功到自成,十大建議。以下準則以半文言的趣味筆法寫就,背後卻都是紮紮實實的工程經驗。
正面:寫好 C 程序的十條準則
- 勤用 lint。應頻繁使用 lint 工具,依其提示修正問題——它的考量往往比你更周全。
- 勿信 NULL 指針。不可盲目依賴空指針,否則混亂與崩潰終將找上門來。
- 強制類型轉換。縱然深知無礙,也應把函數參數強制轉為原型所要求的類型,以免一時疏忽埋下隱患。
- 補全返回類型。若頭文件中的函數原型未聲明返回類型,應親自補上,並再三確認。
- 檢查越界。務必親自核對字符串與數組操作是否越界——所期者短、所獲者長,數組正是最易出事的環節。
- 校核返回值。凡聲明可能返回錯誤碼的函數,都要認真檢查其返回值;哪怕校核讓代碼冗長、手指酸痛,也不可省略。
- 善用庫函數。應研習並複用標準庫函數,而非親手重造輪子,如此代碼更短、可讀性更好,心境也更清爽。
- 保持間架清晰。借助括號與縮進讓代碼結構分明,便於他人借鑑;聰明才智該用在解難上,而非製造謎團。
- 區分外部標識符。外部標識符的前幾個字符應足以區分彼此,這條看似樸素的規則,能讓日後的連接與維護少許多痛苦。
- 遠離異端邪說。對那些斷言「普天之下莫非某平台」、迷信程序能永久跨平台的極端言論,應保持清醒,謹慎對待。
反面:如何寫出「最爛」的 C 程序(別學!)
為了讓人印象深刻,原文還以反諷手法列舉了若干「爛代碼寫法」,權當反面教材:
- 把標準庫函數重寫一遍,改成只有自己才懂的晦澀名字;
- 濫用晦澀、不可移植的私有函數庫,把自己綁死在單一平台上;
- 為每一行代碼都加上「精確描述功能」的冗餘注釋,比如給 printf("Hello world\n"); 配上一句廢話;
- 拒絕使用換行與縮進,堆砌難以閱讀的代碼;
- 從別人代碼裡隨意抄幾條注釋湊數,看別人讀時一臉茫然為樂。
反面:如何測試「最爛」的程序
- 只要代碼能編譯通過,就斷定問題一定出在別人身上;
- 若都是自己寫的,那就一定是不可信的函數庫的錯;
- 宣稱錯誤報告是對你「編程能力」的誹謗,甚至指責測試者根本看不懂你的代碼;
- 如果測試者能順利讀懂你的代碼,那就說明你寫爛代碼的功夫還不到家。
這些「反面教材」當然只是玩笑。真正的結論恰恰相反:勤用工具、檢查邊界、複用標準庫、保持代碼清晰可讀,才是寫好 C 語言的正道。