Python编码基本规范----缩进，注释——总结分析，带实例

目录

• 缩进

• 注释

  单行注释
  多行注释

缩进:

       为了让Python解释器能够准确地理解和执行代码在编写代码时需要遵守一些基本规范。Python最重要的代码编写规范之一就是缩进类似Word文档中的首行缩进。在前面讲解if、for、while等语句的语法格式时都提到过缩进。如果缩进不规范代码在运行时就会报错。先来看下面的代码

1 x = 10
2 if x > 0:
3 	  print('正数')
4 else:
5 	  print('负数')

       Python通过冒号和缩进来区分代码块之间的层级关系因此第3行和第5行代码之前必须有缩进否则运行时会报错。
       Python对代码缩进的要求非常严格同一个层级的代码块其缩进量必须一样否则运行时会报错。但Python并没有硬性规定具体的缩进量默认以4个空格即按4次空格键作为缩进的基本单位。
       在PyCharm中可以用更快捷的方法来输入缩进。1次【Tab】键即可输大1个缩进即4个空格。如果要减小缩进量可以按快捷键【Shift+Tab】。如果要批量调整多行代码的缩进量可以选中要调整的多行代码按【Tab】键统一增加缩进量按快捷键【Shift+Tab]统一减小缩进量。
       需要注意的是按【Tab】键实际上输入的是制表符只是PyCharm会将其自动转握为4个空格。而有些文本编辑器并不会自动转换就容易出现缩进中混用空格和制表符能情况从而导致运行错误。这也是博主推荐使用PyCharm作为代码编辑器的原因之一有许多贴心的功能可以帮助我们避免一些低级错误从而减少代码调试的工作量。

注释:

       注释是对代码的解释和说明Python代码的注释分为单行注释和多行注释两种。

单行注释:

       单行注释以“#”号开头。单行注释可以放在被注释代码的后面也可以作为单独的一行放在被注释代码的上方。放在被注释代码后的单行注释的演示代码如下

1 a = 1
2 b = 2
3 if a == b: # 注意表达式里是两个等号
4     print('a和b相等')
5 else:
6     print('a和b不相等')

代码运行结果如下

1 a和b不相等

       第3行代码中“#”号后的文本就是注释内容从运行结果可以看出注释不参与代码的运行。上述代码中的注释可以修改为放在被注释代码的上方演示代码如下:

1 a = 1
2 b = 2
3 # 注意表达式里是两个等号
4 if a == b:
5     print('a和b相等')
6 else:
7     print('a和b不相等')

       为了增强代码的可读性本博主建议在编写单行注释时遵循以下规范

• 单行注释放在被注释代码上方时在“#”号之后先输入一个空格再输入注释内容。
• 单行注释放在被注释代码后面时“#”号和代码之间至少要有两个空格“#”号与注释内容之间也要有一个空格。

多行注释:

       当注释内容较多放在一行中不便于阅读时可以使用多行注释。在Python中使用3个单引号或3个双引号将多行注释的内容括起来。 用3个单引号表示多行注释的演示代码如下

1 '''
2 这是多行注释,用3个单引号
3 这是多行注释,用3个单引号
4 这是多行注释,用3个单引号
5 '''
6 print('Hello, Python!')

第1~5行代是注释不参与运行所以运行结果如下

1 Hello, Python!

用3个双引号表示多行注释的演示代码如下

1 """
2 这是多行注释,用3个双引号
3 这是多行注释,用3个双引号
4 这是多行注释,用3个双引号
5 """
6 print('Hello, Python!')

       第1~5行代码也是注释不参与运行所以运行结果相同。
      &#160**;注释还有一个作用在调试程序时如果有暂时不需要运行的代码不必将其删除可以先将其转换为注释等调试结束后再取消注释这样能减少代码输入的工作量。**