下一節:, 上一節:, 上層:撰寫 C 程式碼   [目錄][索引]


5.4 變數、函式和檔案的命名

程式中全域變數和函式的名稱本身就是一種註解。因此,不要選擇簡潔的名稱,而應該尋找能夠提供關於變數或函式意義的有用資訊的名稱。在 GNU 程式中,名稱應該像其他註解一樣使用英文。

區域變數的名稱可以較短,因為它們僅在一個上下文中使用,在該上下文中(據推測)註解會解釋它們的用途。

盡量限制在符號名稱中使用縮寫。可以使用一些縮寫,解釋它們的含義,然後頻繁地使用它們,但不要使用大量晦澀難懂的縮寫。

請使用底線來分隔名稱中的單字,以便 Emacs 的單字命令可以在其中發揮作用。堅持使用小寫字母;保留大寫字母給巨集和 enum 常數,以及遵循統一慣例的名稱前綴。

例如,您應該使用像 ignore_space_change_flag 這樣的名稱;不要使用像 iCantReadThis 這樣的名稱。

指示命令行選項是否已被指定的變數,應該根據選項的含義而不是選項字母來命名。註解應該說明選項的確切含義及其字母。例如:

/* Ignore changes in horizontal whitespace (-b).  */
int ignore_space_change_flag;

當您想要定義具有常數整數值的名稱時,請使用 enum 而不是 ‘#define’。GDB 知道列舉常數。

您可能需要確保如果將檔案載入到會縮短名稱的 MS-DOS 檔案系統上,則任何檔案名稱都不會衝突。您可以使用 doschk 程式來測試這一點。

一些 GNU 程式在設計時將檔案名稱限制為 14 個字元或更少,以避免將它們讀入較舊的 System V 系統時發生檔案名稱衝突。請在現有的具有此功能的 GNU 程式中保留此功能,但在新的 GNU 程式中沒有必要這樣做。doschk 也會報告長度超過 14 個字元的檔案名稱。


下一節:, 上一節:, 上層:撰寫 C 程式碼   [目錄][索引]