計算機程式設計/標準和最佳實踐

什麼是“最佳實踐”

計算機程式設計中的標準是指被認定為可接受的程式設計方法，並被推薦為應該採用的方法。就像 GAAP 對會計的作用一樣，程式設計標準允許程式設計師在編寫程式碼時使用共同的標準。與程式設計標準密切相關的最佳實踐，簡單來說就是推薦的編寫程式碼方法。

本節的目標

本節的目的是為初學者提供一份清單，讓他們能夠編寫出不錯的程式碼，並告訴他們這些標準的存在，這樣他們就可以進一步閱讀這些標準，並決定是否要使用它們。

特定語言的最佳實踐

維基程式碼	標準	最佳實踐	模板
C	頁面在這裡	沒有頁面	沒有頁面
C++	頁面在這裡	頁面在這裡	沒有頁面
C#	沒有頁面	沒有頁面	沒有頁面
Java	沒有頁面	頁面在這裡	沒有頁面
Perl	沒有頁面	沒有頁面	沒有頁面
Python	沒有頁面	PEP 8	沒有頁面
Makefile	沒有頁面	沒有頁面	沒有頁面
Apache Ant	沒有頁面	頁面在這裡	沒有頁面
JavaScript	沒有頁面	頁面在這裡	沒有頁面
Visual Basic	頁面在這裡	沒有頁面	沒有頁面

與語言無關的最佳實踐

• 使用版本控制系統。 . 最常見的是：git
• 建立 License.txt 檔案
• 使用適當的構建系統，例如 Meson、CMake、Makefile、Apache Ant、Gradle、Buildr…
• 使用程式碼格式化器。 考慮配置你的編輯器，以便每次儲存檔案時執行格式化器。
• 使用 文件生成器
• 啟用編譯器警告。
• 修復所有編譯器警告。
• 如果你的語言有好的 linter 可用，執行它們並修復所有警告。
• 要有適當數量的單元測試。
• 使用 404 連結檢查器，以確保你的文件中沒有 404 連結。
• 如果你正在使用記憶體不安全的語言 - 使用 ubsan 執行你的測試。
• 如果你的程式碼的一部分可以進行模糊測試，就對其進行模糊測試。

重要的是，你不應該只執行一次單元測試、模糊測試器、linter、程式碼格式化器和 404 連結檢查器，而應該在每次更改程式碼時都執行它們。 單元測試的目的是確保你的程式碼在進行更改後能夠正常工作，而不是檢查它是否能正常工作。 或許可以將這些工具新增到你的 pre-commit 鉤子 中。 大多數專案都會配置他們的伺服器，以便在有人建立拉取請求時執行這些工具。

有爭議的與語言無關的最佳實踐

以下是一些開發人員認為是最佳實踐，而另一些開發人員認為是壞習慣的實踐。

• 使用 測試驅動開發