代码语法规范

发表于 2019-10-19更新于 2019-10-19字数统计 468阅读时长 3m

代码语法规范

一个语言一段代码，从来就不是只是给机器阅读，
更多是给人阅读。
因此为使人更好的阅读代码，产生了一些约定俗成的代码规范。

首先是缩进

使用一个打印九九乘法表的程序来示例：

Python

1
2
3
4
for i in range(1, 10):
    for j in range(1, i+1):
        print("%dx%d=%2d " %(i, j, i*j), end = '')
    print()

C

1
2
3
4
5
6
7
8
9
10
11
12
13
14
#include <stdio.h>

int main()
{
    for(int i = 1; i < 10; i++)
    {
        for(int j = 1; j <= i; j++)
        {
            printf("%dx%d=%2d ", i, j, i*j);
        }
        printf("\n");
    }
    return 0;
}

C++

1
2
3
4
5
6
7
8
9
10
11
12
13
14
#include <iostream>

int main()
{
    for(int i = 1; i < 10; i++)
    {
        for(int j = 1; j <= i; j++)
        {
            std::cout << i << 'x' << j << '=' << i*j;
        }
        std::cout<<endl;
    }
    return 0;
}

Java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
public class Jiujiu
{
    public static void main(String[] args)
    {
        for(int i = 1; i < 10; i++)
        {
            for(int j = 1; j <= i; j++)
            {
                System.out.printf("%dx%d=%2d ", i, j, i*j);
            }
            System.out.println();
        }
    }
}

从上面的各个语言代码中可以看出，通过使用缩进可以让代码的各个部分逻辑层次分明。

空格的使用

举一个非常极端的例子

1
i+++++i

这就让人摸不着头脑，但换成下面的就好理解多了。 

1
i++ + ++i

继续善用空格，个人认为把语句全都堆在一起不怎么好看

1
2
3
for(int i = 1; i < 10; i++)

for(int i=1;i<10;i++)

一些编辑器的设置

编码最好使用UTF-8
设置tab转空格
因为不同编辑器的tab长度不一定一致，这样就能保持代码的一致性，免得python对缩进敏感的无故报错。

PEP 8

想要了解更多的同学可以查看python的一个代码格式设置指南

官方文档
CSDN翻译文档
简书翻译文档