美文网首页
代码规范

代码规范

作者: luxidia | 来源:发表于2021-05-05 14:00 被阅读0次

    妈妈再也不用担心我的代码把自己丑哭了。
    这篇主要讲基本语法中的代码格式规范。
    变量命名规范请移步编程命名规范 - 简书 (jianshu.com)

    代码规范化的七大原则

    1、空行

    规则一:
    定义变量后要空行

    int a;
    
    

    规则二:
    每个函数定义结束之后都要加空行、

    function pri;
    
    

    2、空格

    规则一:
    关键字之后要留空格

    while  (a == 0){
    }
    

    规则二:
    函数名之后不要留空格,应紧跟左括号

    pri()
    

    规则三:
    向后紧跟。
    , ;这三个向前紧跟,紧跟处不留空格。

    for (i = 0; i < a.len; i++){
        print("a=", a.num[i]);
    }
    

    规则四:
    , 后面要留空格
    ; 若不在一行结尾处,后面要留空格
    样例见规则三
    规则五:
    双目运算符(赋值、关系、算数、逻辑、位运算符)前后应加空格

    a + b == c
    x = 1
    

    规则六:
    单目运算符前后不加空格

    if(!a)
    b++;
    

    规则七:
    对于表达式比较长的 for 语句和 if 语句,为了紧凑可以适当去掉一些空格

    3、成对书写

    括号、引号等成对出现的符号书写时成对书写,再往里填充内容。

    for ()
    for (i = 0; i < a; i++)
    
    if ()
    if (a < 0)
    
    if (a < 0){
    }
    
    if (a < 0){
        a = b;
    }
    
    
    print()
    print("")
    print("Hello, world!")
    

    5、缩进

    基本上按照python那套缩进规则来就行。
    一般情况下,顺序结构不缩进,函数、条件、循环内部代码块缩进。
    缩进最好使用4个空格而不是Tab。
    Tab是制表符,通常情况下,一个Tab的尺寸等于四个空格。但在不同的编辑器里,Tab尺寸会有区别。特别的,在使用python语言的时候,使用Tab缩进会造成编译错误。

    6、代码行

    规则一:
    一行代码只做一件事情,如只定义一个变量,或只写一条语句。
    这里的一件事情个人理解为,一个分号 ; 结束的语句。

    int a;
    int b1, b2;
    a = 1;
    

    规则二:
    大括号{}内的代码要向内缩进一个Tab(4个空格),且同一地位的左对其,不同地位的继续缩进。

    while (a > 0){
        b = 0;
        if  (c > 0){
            b = b + c;
        }
        a++;
    }
    

    7、注释

    规则一:注释是对代码的提示而不是文档。
    规则二:如果代码本来就是清楚的,则不必加注释。

    参考来源:https://www.zhihu.com/question/278511114/answer/1317817479

    相关文章

      网友评论

          本文标题:代码规范

          本文链接:https://www.haomeiwen.com/subject/fmpkdltx.html