C++入职学习篇--代码规范（持续更新）

C++入职学习篇--代码规范（持续更新）

一、头文件规范

在头文件中大家一般会定义宏、引入库函数、声明、定义全局变量等，在设计时最后进行分类，代码示范（自己瞎琢磨的，请多多指点）：

#ifndef TEXT_H
#define TEXT_H
//------------------------------------------------
#include <string>
#include <stdio.h>
//------------------------------------------------
#include "picture,h"
#include "work.h"
//------------------------------------------------  
//your code
//------------------------------------------------
#endif /* endif TEXT_H */

最好将宏定义、标准库、自定义库分开，这样更清晰、便于读者阅读

二、类定义规范

在定义类时public、private、protected都需要写出来，即使没有内容，代码示例：

class text()
{
public:
    //------------------------------------------------
    //your code
    String GetName(void);
    //------------------------------------------------
private:
    //------------------------------------------------
    //your code
    String name;
    String _usr_path_name(String filename);
    //------------------------------------------------
protected：
    //------------------------------------------------
    //your code
    //------------------------------------------------
};

三、部分注释为了整体代码规范，需要在必要的时候添加

如果在一个场景中引用的四个工具类A、B、C、D，其他分析均对其四个分别分析，但是有一种情况仅需对其一分析，那就需要用注释分析其他三种，为了就是代码美观与整体性好。代码示例：

bool isopen（mode type）{
    if(type == A->mode){
        project->mode = A->mode;
        return true;
    }

    /*
    if(type == B->mode){
        project->mode = B->mode;
        return true;
    }*/

    /*if(type == C->mode){
        project->mode = C->mode;
        return true;
    }*/
    
    /*if(type == D->mode){
        project->mode = D->mode;
        return true;
    }*/
    
    
}

这样整体美观，便于读者分析