下一節:,上一節:,上一層:頂層   [目錄][索引]


1 關於 GNU 編碼標準

GNU 編碼標準由 Richard Stallman 及其他 GNU 專案的志願者撰寫。其目的是使 GNU 系統清晰、一致且易於安裝。這份文件也可以作為編寫可攜式、穩健和可靠程式的指南。它主要關注以 C 語言編寫的程式,但即使您使用其他程式語言編寫程式,許多規則和原則也很有用。這些規則通常會說明以某種方式編寫的原因。

如果您不是直接從 GNU 專案取得這份文件,且最近沒有檢查更新,請檢查是否有更新的版本。您可以從 GNU 網站伺服器取得 GNU 編碼標準,有多種不同的格式,包括 Texinfo 原始碼、PDF、HTML、DVI、純文字等等,網址為:https://gnu.dev.org.tw/prep/standards/

如果您正在維護官方的 GNU 套件,除了這份文件之外,請閱讀並遵循 GNU 維護者資訊(請參閱目錄,位於GNU 軟體維護者資訊中)。

如果您想接收這些 GNU 文件每次變更的差異(diff),請透過網頁介面加入郵寄清單 gnustandards-commit@gnu.org,網址為 https://lists.gnu.org/mailman/listinfo/gnustandards-commit。 檔案庫也於該處提供。

請將針對這份文件的更正或建議發送至 bug-standards@gnu.org。如果您提出建議,請包含建議的新措辭,以幫助我們有效率地考慮該建議。我們偏好針對 Texinfo 原始碼的上下文差異(context diff),但如果您覺得困難,您可以針對這份文件的其他版本製作上下文差異,或以任何能清楚表達的方式提出建議。這份文件的原始碼儲存庫可以在 https://savannah.gnu.org/projects/gnustandards 找到。

這些標準涵蓋了編寫 GNU 套件時最重要的最低要求。很可能,對額外標準的需求將會出現。有時,您可能會建議將這些標準添加到這份文件中。如果您認為您的標準通常會很有用,請務必提出建議。

您也應該針對您的套件,在許多此處未提及或未明確指定的問題上設定標準。最重要的一點是要自我一致——盡量堅持您選擇的慣例,並盡可能地記錄它們。這樣,您的程式將更容易被其他人維護。

GNU Hello 程式作為一個範例,示範如何為一個簡單的程式遵循 GNU 編碼標準。 https://gnu.dev.org.tw/software/hello/hello.html

此版本的 GNU 編碼標準最後更新於 2024 年 5 月 26 日。


下一節:,上一節:,上一層:頂層   [目錄][索引]