每个公司编码福建省体彩网应包含的7个部分

制定公司编码福建省体彩网绝对至关重要 以确保每个嵌入式开发人员都在同一页面上。编码 福建省体彩网告诉开发人员需要做的许多事情 编写清晰,可审核的软件,以实现所需的业务 质量等级,缺陷数量最少。我已经审查并 在我的职业生涯中写了几十个编码福建省体彩网, 产生最佳结果通常包括我们要进行的七个部分 在今天的博客中进行探索。

第1节-范围

定义公司福建省体彩网将涵盖的范围是 真的很重要,常常被忽视。我看到很多福建省体彩网包括 目的,但坦率地说,为什么存在该福建省体彩网并不像 福建省体彩网范围。范围告诉读者福建省体彩网正在计划中 涵盖以及适用于谁!是仅适用于C开发人员的福建省体彩网 微控制器应用程序还是包括编写Linux的开发人员 应用程序还是在做Linux内核工作?该福建省体彩网仅适用于新 开发的代码,还是需要将福建省体彩网应用于遗留代码?可以 涵盖第三方库代码吗?范围为 福建省体彩网的其余部分以及应该继续阅读的是谁 implementing it.

第2节–验证

我喜欢在编码中包含的第二部分 福建省体彩网是有关如何验证福建省体彩网的建议。我有时候 参见像商业计划书一样使用的编码福建省体彩网;花费大量时间和精力 编写它,但是一旦完成,它就会放在架子上,而且永远不会 再次提及。这就是为什么我认为重要的是告诉读者如何 该福建省体彩网应进行验证。

编码福建省体彩网可以有很多不同的方式 已验证。这些通常包括代码审查和静态代码分析的组合。 好的福建省体彩网应使用工具自动验证,但这不是 总是可能的。我还发现对何时发表评论很有用 建议开发人员验证福建省体彩网。例如,应该 开发人员在提交代码之前,提交过程中验证福建省体彩网 作为持续集成过程的一部分?仅在发布时?这些是 公司开发过程中经常涉及的问题 变化,所以我经常提出一些建议,但要留出灵活性 做最有意义的过程。

第3节–外部参考

诸如C之类的嵌入式编程语言已经存在 半个世纪。没有理由开始制定福建省体彩网 刮!这就是为什么我相信任何公司编码福建省体彩网中的第三部分 应该是确定应该遵循和遵循的外部参考 至。例如,一家公司可能会参考诸如MISRA-C之类的行业福建省体彩网 或CERT-C,然后列出应遵循哪些指令的期望 以及哪些可以忽略。这些外部参考资料允许福建省体彩网 建立在行业已经奠定的基础上,可以简化 制定公司福建省体彩网所需的工作。

第4节-C风格指南

几乎每个开发人员都有自己的C语言样式 码。 C样式指南部分可能是最重要的部分, 确保正在开发的代码库具有一致的外观,以确保 它。这部分列出了重要的准则,例如:

  • 间距
  • 括号放置
  • 允许的C关键字
  • 避免使用的C关键字
  • 注释块应如何显示
  • 命名约定
  • 等等

如果开发人员都坚持使用C风格,那应该差不多 无法确定谁编写了代码,因为每个模块都应该看起来像 same!

第5节–项目

我还发现,对建议进行布局很有用 关于如何组织项目的信息。例如,本节可以讨论 areas such as:

  • 对软件进行版本控制
  • 如何组织软件层和模块
  • 推荐的硬件抽象层,例如CMSIS
  • 如何处理中断服务程序 堆栈,堆和内存管理
  • 有关集成第三方组件的建议。
  • 等等

包括这些详细信息还可以确保每个 团队从事的项目是一致的,开发人员可以轻松移动 从一个项目到下一个项目。

第6节–硬件/编译器特定功能

开发人员还需要接口的建议 硬件并使用编译器。例如,本节可以概述 是否可以使用#pragma,如果可以,则允许使用什么指令。 (已授予 这是特定于编译器的,因此更改编译器意味着更改福建省体彩网, 因此,外部参考文档可能更有意义)。本节还可以 演示与硬件寄存器接口的首选方法 中断。例如,直接访问注册,通过 指针机制或使用指针配置结构。任何相关 硬件和编译器将在此处记录。

第7节–附录

附录可以包含大量信息,包括 对开发人员很重要,但不一定属于其余 编码福建省体彩网。例如,一个团队可能包含一个附录,该附录定义了 “术语表”,以便公司的任何新开发人员都可以学习 公司内部使用的术语,但不一定是 行业认可的术语。跟踪此类信息可以确保 编码人员需要的所有东西都放在一个地方,这样他们就不需要浪费 如果他们需要参考它,那就去寻找它。

结论

公司编码福建省体彩网是重要的文件, 每个开发团队都应该拥有。这些文件奠定了基础 实施了哪个项目,并且可以极大地影响代码库 质量。如果您有编码福建省体彩网,则应至少一次对其进行审查。 一年,以确保其指导仍然有意义。如果您没有 编码福建省体彩网,您可以首先使用此博客的建议部分作为 您每月更新一次的福建省体彩网文档的大纲,直到获得 完整记录的编码福建省体彩网。如果速度不够快,请随时联系 out to me at jacob@beningo.com 和我 将为您提供一些有关如何加快公司编码福建省体彩网的选择 development.

发表评论

您的电子邮件地址不会被公开。 必需的地方已做标记 *

该网站使用Akismet减少垃圾邮件。 了解如何处理您的评论数据.