美化固件以方便开发

精心开发的固件可以很漂亮。遗憾的是,我看过的大多数代码不仅不漂亮,而且谈不上好看。整洁、工整和方便阅读的固件不仅好看,更重要的是,通常也更容易理解。易理解能力的提升可以使得代码更容易调试和维护。下面是如何确保你的固件更加好看更加容易阅读的一些想法。

想法1—遵循格式指南

遵循某种格式指南也许是获得整洁、可阅读代码的最明显途径之一。即使使用格式指南是显而易见要做的事,但我看到许多开发人员要么没有格式指南,要么完全忽视他们已经有的格式指南。一种格式指南具有规定每位开发人员应该如何组织代码美学的优势。遵循规律正确使用格式指南的结果是看起来一致的统一代码库。

网络上有许多很好的格式指南例子。大多数例子采用word格式,允许开发人员方便地根据他们自己的格式和目的进行修改。开发人员需要确保他们的格式指南经过同行评审或使用自动化工具得到强制实施。

想法2—设置统一的制表符间距

如果将10位开发人员召集在一起、问他们喜爱的文本编辑器是什么,那么最可能得到10种不同的答案。答案覆盖范围包括Eclipse、SlickEdit、 Sublime Text、 NotePad++、VIM、Nano等等。每位开发人员都有自己的喜好,而且正如人们预期的那样,这些编辑器处理空格和制表符的方式都不一样,当把在不同编辑器中开发的代码段汇聚到一起时代码的间格和对齐效果会完全被破坏掉。没有什么事情比打开一个文件发现曾经齐准的配置表变得歪歪扭扭更让人恼火的了。

一般编辑器的制表符设置为8个字符,但没人能够保证这个规定永远不变。比如我用过的一些编辑器默认将制表符间距设为4个字符。一个好的格式指南应该告诉开发人员在他们的IDE中使用哪种设置,这样一旦在一种编辑器中编写了代码,这些代码就能够很容易在另一种编辑器中打开而不丢失空格和代码对齐效果。

想法3—使用制表符到空格的转换

老实说,不管怎样开发人员都不应该使用制表符对齐他们的代码。开发人员应该使用空格键。但谁会愿意在能按一次键的情况下偏去按3次、4次甚至更多次的空格键呢?

幸运的是,许多文本编辑器都有一个隐藏的功能,即把文件中的任何制表符转换为等效的空格!制表符到空格转换功能可以帮助开发人员更快的编写出代码,然后在提交代码前转换制表符,释放源自编辑器设置的对齐功能。当然,这里的技巧首先是要确保配置了正确的制表符参数,然后严格遵守规定运行转换器。

想法4—使用代码美化器

即使是最守纪律的开发人员遵循了格式指南,设置了制表符间隔,仍可能得到难看的代码。原因是什么呢?开源代码。许多开发人员自愿或被迫使用开源软件,这些开源软件通常看起来像老鼠窝或一盘面条一样杂乱。你见过传感器或芯片制造商提供的例子代码吗?我只能说他们心中根本就没有美丽这个字眼。

好在开发人员可以借助神一样的代码美化器。代码美化器是一种简单的工具,它会扫描整个文本文件,然后根据输入格式化参数设置对文件进行格式化处理。那些没有对齐、很难阅读的代码可以瞬间转换成工整可阅读的代码。用谷歌搜索代码美化器可以找到大量免费的在线代码美化器。市场上也有价格不到100美元的大量商用代码美化器。

不过代码美化器真的不应该用来处理开发人员自己编写的代码。开发人员应该遵循他们自己的格式指南,以规定好的方式开发软件。代码美化器工具只可用来处理不满足格式指南的供应商代码和开源代码。

码库网基于大数据与人工智能,提供IC芯片交易,芯片选型分类,IC芯片丝印反查,元器件封装垂直搜索服务;结合线下PCB制造,SMT制造优势提供一站式解决方案和专业的技术支持,产品100%正品,质量/售后有保障。

转载请注明:聚龙信息网,电子产品开发,程序编程,方案公司,技术开发,大数据,信息平台 » 美化固件以方便开发

喜欢 ()or分享