C庫代碼的正確命名約定

Question

對基於C的代碼庫/ API的一部分的文件和函數進行命名的正確方法是什麼？

Answer 1

什麼你可以（但不應該）做的是完全不小心，沒有使用任何系統的命名約定的。這個'有效'，但會讓你的顧客感到不舒服;他們沒有簡單的方法知道他們可以在自己的程序中使用哪些名稱。 （我遇到一個庫，它定義了一個名爲error()的內部使用的未公開函數，名稱與外部文檔名稱空間的任何部分都不匹配，當時我自己的一個標準錯誤報告函數也被稱爲error() - 雖然現在是err_error();這意味着我無法使用自己的標準錯誤報告功能與該庫。結果是我沒有使用該庫，如果我不必這樣做;這太麻煩了使用。）

所以，你不應該那樣。你應該小心你公開的名字。

你的公共頭文件應該使用一個（或者很少的）系統前綴，這些前綴被記錄在案。通常情況下，您會選擇一個前綴，如PFX，並使用該前綴：

• 枚舉常量開始PFX_。
• 宏開始PFX_。
• 函數開始pfx_。
• 全局變量（你沒有任何這些，你）開始pfx_。
• 類型名稱和結構或聯合標記開始pfx_。
• 他們自己的源文件以外可見你的私有變量和函數有一個系統的前綴（可能pfx_再次，也許pfxp_其中最後p是私有的，或者是pfx[A-Z]使民營名稱是駱駝，套管，但開始pfx）。

只有嚴格文件範圍（無外部鏈接）的變量或函數不受這些規則的限制，但即使如此，建議使用命名約定（所以如果函數需要使用兩個文件稍後，您不必修改功能之前的代碼中的調用static）。

通過這種方式，您可以簡單地記錄從您的庫中保留的名稱PFX_或pfx_。用戶仍然可以使用具有相同前綴的名稱（不能阻止它們），但他們自己承擔風險，因爲升級到庫可能會添加保留的名稱。他們可以很好地清楚你的名字，因爲你已經記錄了他們，並且因爲文檔相對容易理解。

請注意，C標準和POSIX標準都規定了保留名稱的規則。但是，保留的POSIX和C名稱的規則比單個前綴複雜得多。他們也在掃地。例如，如果包含任何POSIX頭文件，POSIX保留所有以_t結尾的名稱作爲類型名稱。