代码编程规范

最新推荐文章于 2024-04-11 22:03:59 发布

吴自牧

最新推荐文章于 2024-04-11 22:03:59 发布

阅读量916

点赞数 31

文章标签： c语言 c++

本文链接：https://blog.csdn.net/weixin_49621395/article/details/137332562

版权

在最开始接触程序编写代码的时候常常会因为变量命名，程序格式等问题困扰，找不到最适合自己又能让别人清晰明了的查看代码，在查看了华为代码规范之后，感觉里面的方法有一些确实能提高代码的可读性，故摘抄一些对自己有益的。

一、命名规范

1.1、类名和函数名用大写字母开头的单词组合而成

eg：

        class Node; // 类名

        class LeafNode; // 类名

        void Draw(void); // 函数名

        void SetValue(int value); // 函数名

1.2、常量全用大写的字母，用下划线分割单词

eg：

const int MAX = 100;

const int MAX-LENGTH = 100;

1.3、静态变量加前缀 s_（表示static）

eg:

        void Init(…)
        {
          static int s_initValue; // 静态变量
          …
    }

1.4、如果不得已需要全局变量，则使全局变量加前缀g_（表示global）

eg：

int g_howManyPeople; // 全局变量
int g_howMuchMoney; // 全局变量

1.5、类的数据成员加前缀 m_（表示 member），这样可以避免数据成员与成员函数的参数同名

eg：

void Object::SetValue(int width, int height)
{
m_width = width;
m_height = height;
}

1.6、为了防止某一软件库中的一些标识符和其它软件库中的冲突，可以为各种标识符加上能反映软件性质的前缀。例如三维图形标准 OpenGL 的所有库函数均以 gl 开头，所有常量（或宏定义）均以 GL 开头

二、表达式和基本语句

2.1、运算符的优先级

C++/C 语言的运算符有数十个，运算符的优先级与结合律如表 4-1 所示。注意一元运算符 + - * 的优先级高于对应的二元运算符。

三、内存管理

640K ought to be enough for everybody

— Bill Gates 1981

3.1、内存分配方式

内存分配方式有三种：

（1）从静态存储区域分配

内存在程序编译的时候就已经分配好，这块内存在程序的整个运行期间都存在。例如全局变量，static 变量。

（2）在栈上创建。

在执行函数时，函数内局部变量的存储单元都可以在栈上创建，函数执行结束时这些存储单元自动被释放。栈内存分配运算内置于处理器的指令集中，效率很高，但是分配的内存容量有限。

（3）从堆上分配，亦称动态内存分配。

程序在运行的时候用 malloc 或 new 申请任意多少的内存，程序员自己负责在何时用 free 或 delete 释放内存。动态内存的生存期由我们决定，使用非常灵活，但问题也最多。

3.2、常见的内存错误及其对策

（1）内存分配未成功，却使用了它

常用解决办法是，在使用内存之前检查指针是否为 NULL。如果指针 p 是函数的参数，那么在函数的入口处用 assert(p!=NULL)进行检查。如果是用 malloc 或 new 来申请内存，应该用 if(p==NULL) 或 if(p!=NULL)进行防错处理。

（2）内存分配虽然成功，但是尚未初始化就引用它

犯这种错误主要又两个起因：

一是没有初始化的观念;

二是误以为内存的缺省初值全为零，导致引用初值错误（例如数组）。

内存的缺省初值究竟是什么并没有统一的标准，尽管有些时候为零值，我们宁可信其无不可信其有。所以无论用何种方式创建数组，都别忘了赋初值，即便是赋零值也不可省略，不要嫌麻烦。

（3）内存分配成功并且已经初始化，但操作越过了内存的边界

例如在使用数组时经常发生下标”多一“或者”少一“的操作。特别是在for循环语句中，循环次数很容易搞错，导致数组操作越界，从而导致段错误（程序异常结束）。

（4）忘记了释放内存，造成内存泄漏

含有这种出错误的函数每被调用一次就丢失一块内存。刚开始时系统的内存充足，你看不到错误。终有一次程序突然死掉，系统出现提示：内存耗尽。

动态内存的申请与释放必须配对，程序中malloc与free的使用次数一定要相同，否则肯定有错误（new/delete同理）。

（5）释放了内存却继续使用它

有三种情况：

程序中的对象调用关系过于复杂，实在难以搞清楚某个对象究竟是否已经释放了内存，此时应该重新设计数据结构，从根本上解决对象管理的混乱局面。
函数的 return 语句写错了，注意不要返回指向“栈内存”的“指针”或者“引用”，因为该内存在函数体结束时被自动销毁。
使用 free 或 delete 释放了内存后，没有将指针设置为 NULL。导致产生“野指针”。

【规则 7-2-1】用 malloc 或 new 申请内存之后，应该立即检查指针值是否为 NULL。防止使用指针值为 NULL 的内存。
【规则 7-2-2】不要忘记为数组和动态内存赋初值。防止将未被初始化的内存作为右值使用
【规则 7-2-3】避免数组或指针的下标越界，特别要当心发生“多 1”或者“少 1”操作。
【规则 7-2-4】动态内存的申请与释放必须配对，防止内存泄漏。
【规则 7-2-5】用 free 或 delete 释放了内存之后，立即将指针设置为 NULL，防止产生“野指针”。