计算机编程/标准与最佳实践
< 计算机编程
计算机编程中的标准是指已被认为可接受的编程方法，并被推荐为应采用的方法。就像GAAP对会计一样，编程标准允许程序员在编写代码时使用共同的基础。紧密联系着编程标准，最佳实践仅仅是指推荐的代码编写方法。
本节的目标是为初学者提供一个清单，使他们能够编写出像样的代码，并告诉初学者这些东西的存在，以便他们可以进一步阅读这些内容并确定是否想使用它们。
| 维基代码 | 标准 | 最佳实践 | 模板 |
|---|---|---|---|
| C | 页面在这里 | 无页面 | 无页面 |
| C++ | 页面在这里 | 页面在这里 | 无页面 |
| C# | 无页面 | 无页面 | 无页面 |
| Java | 无页面 | 页面在这里 | 无页面 |
| Perl | 无页面 | 无页面 | 无页面 |
| Python | 无页面 | PEP 8 | 无页面 |
| Makefile | 无页面 | 无页面 | 无页面 |
| Apache Ant | 无页面 | 页面在这里 | 无页面 |
| JavaScript | 无页面 | 页面在这里 | 无页面 |
| Visual Basic | 页面在这里 | 无页面 | 无页面 |
- 使用版本控制系统。[1][2][3]. 最常见：git
- 创建一个 License.txt 文件
- 使用合适的构建系统，例如 Meson、CMake、Makefile、Apache Ant、Gradle、Buildr...
- 使用代码格式化工具。考虑配置您的编辑器，以便每次保存文件时都运行格式化工具。
- 使用文档生成器
- 启用编译器警告。
- 修复所有编译器警告。
- 如果您的语言有好的代码 linter，请运行它们并修复所有警告。
- 拥有适当数量的单元测试。
- 使用 404 链接检查器来确保您的文档中没有 404 链接。
- 如果您使用的是内存不安全的语言 - 使用ubsan运行您的测试。
- 如果您的代码的一部分可以进行模糊测试，请进行模糊测试。
重要的是，您不应该仅仅运行一次单元测试、模糊测试器、linter、代码格式化工具和 404 链接检查器，而应该在每次更改代码时都运行它们。单元测试的目的是不是检查代码是否有效，而是确保在您更改代码时，代码仍然有效。也许可以将这些工具添加到您的pre-commit hooks中。大多数项目都会在其服务器上配置，以便在有人创建拉取请求时运行这些工具。
以下是一些开发人员认为是最佳实践，而另一些开发人员则认为是坏实践的做法。
- 使用测试驱动开发
- ↑ Troy Hunt. "良好的源代码控制管理的十诫".
- ↑ Joel Spolsky. "Joel 测试：编写更好代码的 12 个步骤".
- ↑ "版本管理".
 |
此页面或章节是一个未完成的草稿或大纲。 您可以帮助完善工作，或者您可以在项目室中寻求帮助。 |