C规范编辑笔记(十一)

news2024/10/6 18:35:55

往期文章：

C规范编辑笔记(一)
C规范编辑笔记(二)
C规范编辑笔记(三)
C规范编辑笔记(四)
C规范编辑笔记(五)
C规范编辑笔记(六)
C规范编辑笔记(七)
C规范编辑笔记(八)
C规范编辑笔记(九)
C规则编辑笔记(十)

正文：

因为太久没有更新了，今天就发两篇吧，我们继续来看C规范编辑笔记的第十一篇笔记。话不多说，直接将~

1、建议——对函数建立专门的功能文档，其描述包括：
(1)、对功能和所执行处理的描述
(2)、每个参数的文档、参数的方向（输入、输出、输入和输出）及其上存在的任何条件；
(3)、必须描述可能的返回值。

以上这些点其实是很有必要的，因为你如果看大厂的资料代码就会发现他们在函数定义和声明时候会在上面对这个函数的参数、作用、返回值做很详细的说明，方便后期其他人为维护，同时也方便我们更好去理解和阅读，因此我们也有必要养成这样的习惯~，对你自己肯定是有帮助的。

2、规则——必须系统地质疑函数所有参数的有效性。尤其是遇到除数时候，需要考虑分母是不是为0的可能性，当然还需要考虑其他，这需要我们视情况来看，比如如下例子：

Bad example:
double division(int32_t n, int32_t d)  
{
	/* d != 0 未验证 */
	return ((double)n) / ((double)d);  //如果d为0，系统会报错
}

Good example:
double division(int32_t n, int32_t d) {
double res = 0.0;
if(0 == d) {     //对d为0的情况做了处理
    /* 错误处理 */
}
else {
        res = ((double)n) / ((double)d);
     }
     return res;
}

3、规则–使用指针参数时候，如果相应带入的参数不被更改，可以在相应形参前面加上关键字const。对参数添加了const参数，可以防止在函数内部操作时候修改我们带入形参的原值。举例：

Bad example:
uint32_t foo(uint32_t *val)
{
    /*这里没有对val指针进行判断，判断其是否是野指针*/
    *val = (*val) * 2;  /*这步操作会导致相应导入的该foo函数的指针参数会被修改值*/
    return *val;
}


Good example:
uint32_t foo(const uint32_t *val)   //对参数添加了const，防止函数内部的修改，影响其带入的原参数值
{
    *val = (*val) * 2; /*这里的修改只会修改val形参的指针值，并不会影响其带入的参数值，因为添加了const*/
            return *val;
}