大家好,我是痞子衡,是正经搞技术的痞子。今天痞子衡给大家讲的是飞思卡尔软件开发C语言编码规范

  2020鼠年春节是个漫长的假期,痞子衡在家百无聊赖,翻出了2016年10月1日(这个时间是痞子衡正式开始用markdown+github写技术文章并发表到博客园上的纪念日)之前写的技术文档,不翻不知道,一翻吓一跳,从2007年上大学开始到2016年这十年间,我真的写了非常多的技术类文章,但都不够完整,没有成系统,排版上也不优雅,底下有时间我会慢慢整理出来,不能让以前的辛苦都被埋没了。

  痞子衡2016年之前所写的那些技术文章除了原创外,也有一些是翻译的,比如今天要分享的这篇就是2013年痞子衡刚入职飞思卡尔半导体MCU软件团队时为了学习C编码规范所翻译的(外企嘛,各种资料都是洋文),当时飞思卡尔刚成立MCU软件团队不久,那时候Kinetis SDK也还没有正式推出,整个团队必须要有一个统一且良好的编码风格,这样写出来的SDK才符合大厂身份。废话不多说,下面是编码规范原文:

1.引言

  制定此编码风格指导手册的目的是为了使按此规范编写出的C/C++代码极易被阅读和理解。

2.与其他编码风格对比

痞子衡嵌入式:知名半导体MCU大厂软件开发C代码规范-LMLPHP

3.基本排版格式

4.文档与注释

5.标准数据类型

6.标识符的命名

  以下是C/C++下变量、函数、typedef、宏命名的基本规则,命名规则可以接受细微改动,但要保证在同一模块中的一致性:

  描述性强的,可读性强的变量名非常重要:

  有时候为了表明范围和目的,有些变量命名是可以加前缀和后缀的:

  备注:切记不要用匈牙利命名法,因为其会导致变量名难于阅读,且类型前缀常常会与变量真正类型不同步,微软曾是此命名法的拥趸,但其已意识到此命名法的缺陷,目前正在逐渐脱离此方法。

7.可调试性

8. C99标准

9.内联功能

  头文件中,内联功能启用应用static inline来完成

10. C/C++通用性

  头文件中的公用函数原型必须包含在下列语句中

#if defined(__cplusplus)
extern "C" {
#endif // __cplusplus // 此处放函数原型 #if defined(__cplusplus)
}
#endif // __cplusplus

  C中一般都用typedef来重命名结构体和枚举数据类型,不要提及原始的结构体或枚举型名

  C++中,则不需用typedef来重命名,直接用原始的结构体或枚举型名;但是如果代码被C/C++共享,则应遵从C风格

  对于被用在C++中的函数(比如类成员)而言,如果函数不带任何参数,则不需要一个专门的void参数来表明,而在C中这是需要的

11.花括号的使用

  花括号的使用虽重要性不高,但经常起争议

  使用规则可以接受细微改动,但要保证在同一模块中的一致性,以及易于阅读

结构体和类示例:
struct Monkey
{
int x;
}; typedef struct MonkeyTwo {
int y;
} monkey_two_t; class Cube
{
public:
Cube(int theSize); private:
int m_size;
};
枚举示例:
enum _my_enum
{
kValueOne = 1,
kValueTwo = 2
}; typedef enum _another {
kAnotherOne = 10,
kAnotherTwo = 20
} another_t;
函数示例:
void foo()
{
printf("hi\n");
}
If语句示例:
if (baz >= kMaximumBaz)
{
baz = kMaximumBaz;
}
else if (!ready)
{
makeItReady();
}
else
{
abort();
}
For语句示例:
for (i=0; i < 10; ++i)
{
printf("%d", i);
}
While语句示例:
while (!done)
{
doSomething();
}
Do-while语句示例:
do {
doSomething();
} while (!done);
Switch语句示例:
switch (value)
{
case 0:
x += 1;
break; case 1:
{
int y;
calculateIt(&y);
break;
} default:
return;
}
命名空间示例:
namespace fsl
{
// Don't indent namespace contents!
}
Try-catch语句示例:
try
{
}
catch (std::exception & e)
{
}
catch (...)
{
}

12. 关于MISRA-C规范

  代码风格基本遵照MISRA-C:20xx规范,但除了以下例外(这些例外是基于MISRA-C:2004规范的)

痞子衡嵌入式:知名半导体MCU大厂软件开发C代码规范-LMLPHP

  至此,飞思卡尔软件开发C语言编码规范痞子衡便介绍完毕了,掌声在哪里~~~

欢迎订阅

文章会同时发布到我的 博客园主页CSDN主页微信公众号 平台上。

微信搜索"痞子衡嵌入式"或者扫描下面二维码,就可以在手机上第一时间看了哦。

痞子衡嵌入式:知名半导体MCU大厂软件开发C代码规范-LMLPHP

05-11 19:34