嵌入式编码注意事项.md · huangtang1699/PicGoRepo

# 箴言
“程序必须为阅读它的人而编写，只是顺便用于机器执行。”
              ——Harold Abelson 和 Gerald Jay Sussman
# 1 标示符命名规则
## 1.1 标识符命名规则

> 规则1.1-1(强制)：标识符（内部的和外部的）的有效字符不能多于31。

> 规则1.1-2(强制)：具有内部作用域的标识符不应使用与具有外部作用域的标识符相同的名称，在内部作用域里具有内部标示符会隐藏外部标识符。

> 规则1.1-3(建议)：具有静态存储期的对象或函数标识符不能重用。

# 2 嵌入式软件安全性相关规范

## 2.1 类型及类型转换

> 规则2.1-1(建议)：浮点应用应该适应于已定义的浮点标准。  
> 说明：浮点运算会带来许多问题，一些问题（而不是全部）可以通过适应已定义的标准来克服。其中一个合适的标准是  ANSI/IEEE Std 754 [1] 。

# 3 嵌入式软件安全性相关规范
### 3.1 整数后缀
 
> 整型常量的类型是混淆的潜在来源，因为它依赖于许多因素的复杂组合，包括：  
> 1) 常数的量级
> 2) 整数类型实现的大小
> 3) 任何后缀的存在
> 4) 数值表达的进制（即十进制、八进制或十六进制）  
例如，整型常量“40000”在32位环境中是 int 类型，而在 16位环境中则是long 类型。  
值0x8000 在16位环境中是 unsigned int 类型，而在 32 位环境中则是（signed ）int 类型。  
注意：  
> 5) 任何带有“U”后缀的值是unsigned 类型  
> 6) 一个不带后缀的小于231的十进制值是signed 类型  
但是：  
> 7) 不带后缀的大于或等于215的十六进制数可能是 signed 或unsigned 类型  
> 8) 不带后缀的大于或等于231的十进制数可能是 signed 或unsigned 类型  
常量的符号应该明确。符号的一致性是构建良好形式的表达式的重要原则。如果一个常数是unsigned 类型，为其加上“U”后缀将有助于避免混淆。当用在较大数值上时，后缀也许是多余的（在某种意义上它不会影响常量的类型）；然而后缀的存在对代码的清晰性是种有价值的帮助。

## 3.2初始化、声明与定义

> 规则3.2-1(强制)：应该使用大括号以指示和匹配数组和结构的非零初始化构造。

> 规则3.2-2(强制)：在枚举列表中，“= ”不能显式用于除首元素之外的元素上，除非所有的元素都是显式初始化的

> 规则3.2-3(强制)：函数应当具有原型声明，且原型在函数的定义和调用范围内都是可见的。

> 规则3.2-4(强制)：定义或声明对象、函数时都应该显示指明其类型。

> 规则3.2-5(强制)：函数的每个参数类型在声明和定义中必须是等同的，函数的返回类型

> 规则3.2-6(强制)：在文件范围内声明和定义的所有对象或函数应该具有内部链接，除非是在需要外部链接的情况下，具有内部链接属性的对象或函数应该使用static关键字修饰。  
>说明：如果一个变量只是被同一文件中的函数所使用，那么就用static。类似地，如果一个函数只是在同一文件中的其他地方调用，那么就用 static。使用 static存储类标识符将确保标识符只是在声明它的文件中是可见的，并且避免了和其他文件或库中的相同标识符发生混淆的可能性。具有外部链接属性的对象或函数在相应模块的头文件中声明，在需要使用这些接口的模块中包含此头文件。

## 3.3控制语句和表达式
> 规则3.3-1(建议)：不要过分依赖C 表达式中的运算符优先规则。

> 规则3.3-2(强制)：不能在具有副作用的表达式中使用sizeof 运算符。  
> 说明：当一个表达式使用了sizeof运算符，并期望计算表达式的值时，表达式是不会被计算的。sizeof只对表达式的类型有用。
实例：
```
INT32S  i;
INT32S  j;
j = sizeof (i = 1234); /* j的值是i类型的大小，但i的值并没有赋值成1234 */
```
> 规则3.3-3(强制)：逻辑运算符 && 或 || 的右手操作数不能包含副作用。  
说明：C语言中存在表达式的某些部分不会被计算到，这取决于表达式中的其他部分。逻辑操作符&&或||在进行逻辑判断时，若仅判别左操作数就能确定true or false的情况下，逻辑操作符的右操数将被忽略。
实例：
```
if ( high && ( x == i++ ) )    /* 不符合规则 */
//若high为false，则整个表达式的布尔值也即为false，不用再去执行和判断右操作数。
```

材料：《C语言接口与实现》、《代码整洁之道》、《Doxygen中文手册》、
[原文地址](https://blog.csdn.net/ChenGuiGan/article/details/81161562)

huangtang1699/PicGoRepo

简介

发行版

贡献者

近期动态

huangtang1699/PicGoRepo .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

huangtang1699/PicGoRepo