计算机编程/标准和最佳实践

什么是“最佳实践”

计算机编程中的标准是指被认定为可接受的编程方法，并被推荐为应该采用的方法。就像 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 钩子 中。 大多数项目都会配置他们的服务器，以便在有人创建拉取请求时运行这些工具。

有争议的与语言无关的最佳实践

以下是一些开发人员认为是最佳实践，而另一些开发人员认为是坏习惯的实践。

• 使用 测试驱动开发