C/C++代码规范

C/C++代码规范

代码格式在一些语言里不是必需的,比如C语言中,你可以在语句之间加任意个;,可以加很多空格;可以一个语句分两行写,也可以把所有代码都放在一行。有些语言就对代码格式非常敏感,比如Python,同一层级的语句之间一定要有相同的缩进。

代码规范是在代码格式上更进一步的要求,为的是使代码更容易阅读、出现错误更容易查错。

为了代码的整洁、漂亮,代码的风格需要统一,也就是说,同一篇代码、同一个项目的代码风格需要保持一致性。一个人的风格可能是固定的,而一个项目的风格通常需要事先制定。

不同人可能持不同的代码风格,但是也有一些规范是大家共同遵守的。可以多阅读已经写好的、规范的代码,来熟悉一些基本的、大家共同遵守的规范。

下面将介绍一下C语言的代码规范大概该注意哪些地方。

缩进

缩进是非常常见的事情,它被用来显示出代码的层级。一般可以用Tab或者空格来形成缩进。

要输入一个Tab,只要按下键盘上的Tab键就好了。

使用Tab做缩进,只需要一个Tab就够了;而使用空格做缩进,一般会使用2或4个空格为一个缩进。

根据不同的编辑器设置或个人习惯,一个Tab可能会被显示成2 / 4 / 8个空格等等。因此,切忌将Tab将空格(Space)和缩进(Tab)混用,这样有可能导致代码显示出来的层次变得混乱,难以阅读。

int foo(int num) {
    // 一级缩进
    if (num % 2 == 0) {
        // 二级缩进
        return num + 1;
    }
    else return num;
}

大括号

一般有两种方式,一种是左大括号“{”放在行末,另一种是{单独占一行。一般第一种更为常见。甚至,会有把else关键字放在if语句大括号的同行。

int foo(int num) {
    if (num % 2 == 0) {
        return num + 1;
    } 
    else return num;
}

大括号换行的写法:

int foo(int num)
{
    if (num % 2 == 0)
    {
        num *= 2;
        num += 1;
    } 
    return num;
}

当然,格式都不是绝对的,可以根据情况灵活调整,只要方便阅读就好。比如如果几条语句比较简单、逻辑关联强,也可以放在一行。

<template class T>
std::vector<T> stack_reverse(std::stack<T> _stack) {
    std::vector<T> result;
    while (!_stack.empty()) { result.pusk_back(_stack.top()); _stack.pop(); }
    return result;
}

空格

比如ifelseforwhile关键字后留空格,可以突出关键字。而相对应的,函数名后的括号要紧跟

void print_vector_int(const std::vector<int> & a) {
    for (auto i : a) std::cout << i << ' ';
    std::cout << std::endl;
}

左右括号()一般紧紧包裹其中的内容,而,;则紧紧跟着其左侧的字符,其右侧要留一个空格。

std::vector<int> a = {1, 2, 3, 4, 5};

双目运算符(如+-===+=<%等)的左右都要留空格。

int num1 = 10 / 2;
int num2 = 20 % 3;
int val = num1 + num2;

单目运算符(如!++--*&等)紧跟它的操作数,前后不留空格。

std::vector<int> a = {
    1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
};
auto i = a.begin();
while (i != a.end()) {
    std::cout << *i << ' ';
    ++i;
}

方括号[]、成员运算符.->也紧跟其操作数,即前后不留空格。

std::vector<int> a = {1, 2, 3, 4, 5};
a[0] = a[1] + a[2];
a.erase(a.begin());

int val = 10;
auto b = new std::vector<int>();
b->push_back(val);
b->erase(b->begin());

符号命名

养成良好且规范的变量 / 函数命名方式和习惯。

参考阅读:

符号的命名主要有下划线法、驼峰法等,比如find_first_of()namedWindow()等。

宏名枚举名(其实枚举就可以视作一种宏定义)一般采用全大写+下划线,比如BGR2GRAYMAX_LENGTHBLUE等。

一般来说,函数、局部变量名、全局变量名、宏名等,可以采用不同的命名法以区分彼此。

变量名也应具有一定的意义,比如tmptemp一般表示临时变量,ijk等一般用作迭代,cnt一般用来计数。

struct MyStruct {
    int val_a;
    int val_b;
    char class_type;
    enum Type {TYPE_A, TYPE_B};
    
    bool isValid() { return val_a > 10 && val_b > 20; }
}

注释

写代码的时候记得添加一些注释。良好的注释可以方便自己和别人阅读和修改代码。

不必要事无巨细,在关键部分给出提示即可。

通常,对于一个函数应该写明其具有的功能、函数各个参数的意义;对于变量要有对其作用的介绍。这样性质的注释一般写在函数或变量的声明处附近。而对于函数的定义部分也最好有相应的解释,可以告诉读者某行或某段代码实现了什么事情、或者为什么这样写。

很多编辑器、IDE可以识别到这些注释,并在鼠标悬停在它们的调用上时显示出函数的原型和注释,很是方便。

函数、变量名本身也应该体现一定的意义。如果得当,那么代码则具有自述性(self-explaining),而不必要额外再写注释了。

不建议用中文拼音为符号命名,更不要用中文缩写,因为中文的缘故,同音词很多,相同拼音首字母的词语更多,别人很难联想到具体是什么词语。既然是用26个英文字母编程,那么也建议使用英语给变量起名。

起变量名在一定程度上也需要一定的英语考究,比如一些词虽然意思相近,但其中的一个会比其他的更合适。

下面是“选猴王”(也就是“约瑟夫问题”)的参考代码:

// return the postion number of the monkey king
int get_monkey_king(int n, int m) {
    std::queue<int> monkeys_queue;
    for (int i = 1; i <= n; ++i) monkeys_queue.push(i);
    cnt = 0;
    while (monkeys_queue.size() > 1) {
        ++cnt;
        auto monkey = monkeys_queue.front();
        monkeys_queue.pop();
        if (cnt == m) cnt = 0; 
        else monkeys_queue.push(monkey);
    }
    std::cout << monkeys_queue.front() << std::endl;
}

int main() {
    std::cin >> n >> m;
    std::cout << get_monkey_king(n, m);
}
已标记关键词 清除标记
©️2020 CSDN 皮肤主题: 数字20 设计师:CSDN官方博客 返回首页