您当前的位置:首页 > 电脑百科 > 程序开发 > 编程百科

为什么代码风格很重要、来看看µC/OS代码规范

时间:2020-12-10 11:04:13  来源:  作者:

开发过项目的工程师都知道,一个好的项目,代码基本都有统一的规范,否则代码就会随着版本迭代,变得越来越臃肿。

代码规范应在项目早期建立,这些规范对于保持整个项目的一致性非常有必要,采用一致的规范可以提高效率并简化项目维护。

采用一致的规范可以:

  • 可移植性
  • 一致性
  • 整洁
  • 维修方便
  • 容易理解
  • 简单


下面来看看著名的µC/OS代码的规范。

一、标头

C源文件的标头如下所示,公司名称和地址可以在前几行,后跟一个标题,用于描述文件的内容。其中包含版权声明,以警告该软件的专有性等。

为什么代码风格很重要、来看看µC/OS代码规范

 

二、包含文件

#include包含通常有两种方式,在源文件中包含所需的头文件,还有一种把所有头文件都整理在一个文件,比如INCLUDES.H。这样你就不必记住哪个头文件与哪个源文件一起使用,尤其是在添加新模块时。唯一的不便是编译每个文件需要更长的时间。

为什么代码风格很重要、来看看µC/OS代码规范

 

三、命名标识符

符合ANSI C标准的C编译器(到目前为止,大多数C编译器都这样做)最多允许32个字符作为标识符名称。标识符是变量、结构/联合成员、函数、宏、#defines等。

比如:大写字符用于分隔标识符中的单词,功能和下划线字符(_)类似。

为什么代码风格很重要、来看看µC/OS代码规范

 

µC/OS命名标识符:

  • 函数声明中的形式参数应仅包含小写字符。
  • 自动变量名称应仅包含小写字符。
  • 静态变量和函数应使用文件/模块名称(或其一部分)作为前缀,并应使用大写/小写字符。
  • extern变量和函数应使用文件/模块名称(或其一部分)作为前缀,并应使用大写/小写字符。

四、缩略

代码基本都会使用缩写,缩写不能中英文混合,通常是英文的缩写,比如OS代表Operating System。

一些常用的缩写需要统一规范,一些不常用的缩写需要在代码中注释清除。

µC/OS代码中使用的缩写比较多,比如:

为什么代码风格很重要、来看看µC/OS代码规范

 

五、注释

// /* */ 是两种最常见注释的方法,还有注释的位置也很关键。通常在代码所在行上一行,或者在代码所在行(代码后面)。

但也有奇葩把代码注释在代码所在行的下一行(通常不建议这么操作)。

µC/OS使用 /**/ 而且都在代码所在行(后面):

为什么代码风格很重要、来看看µC/OS代码规范

 

六、#defines

头文件(.H)和C源文件(.C)可能需要定义常量和宏,常量和宏始终使用大写字母。

为什么代码风格很重要、来看看µC/OS代码规范

 

七、数据类型

C语言允许你使用typedef关键字创建新的数据类型,µC/OS使用大写字符声明所有数据类型,因此遵循用于常量和宏的相同规则,永远不会混淆常量,宏和数据类型的问题。

为什么代码风格很重要、来看看µC/OS代码规范

 

八、局部变量

一些源模块要求使用局部变量,通过使用static关键字,变量可以按字母顺序或功能顺序列出。

为什么代码风格很重要、来看看µC/OS代码规范

 

九、缩进

缩进有使用空格和Tab两种符号,规范通常只使用一种,不能空格和Tab两种混合使用(现在很多编辑器都支持Tab替换成空格的功能)。

如果混合使用,在不同编辑器打开代码,你就可能会看到一团糟。

µC/OS使用四个空格:

为什么代码风格很重要、来看看µC/OS代码规范

 

十、结构体和联合体

包含结构体和联合体的格式、命名、注释等这些都需要规范,µC/OS代码使用的比较简单,也是大众化的定义:

为什么代码风格很重要、来看看µC/OS代码规范

 



Tags:代码风格   点击:()  评论:()
声明:本站部分内容来自互联网,转载是出于传递更多信息之目的,内容观点仅代表作者本人,如有任何标注错误或版权侵犯请与我们联系,我们将及时更正、删除,谢谢。
▌相关评论
发表评论 共有条评论
用户名: 密码:
验证码: 匿名发表
▌相关推荐
开发过项目的工程师都知道,一个好的项目,代码基本都有统一的规范,否则代码就会随着版本迭代,变得越来越臃肿。代码规范应在项目早期建立,这些规范对于保持整个项目的一致性非常有...【详细内容】
2020-12-10   代码风格  点击:(0)  评论:(0)  加入收藏
相关文章
    无相关信息
最新更新
栏目热门
栏目头条