【python】python代码注释和编码风格

一、代码注释

Python 支持两种类型的注释，分别是单行注释和多行注释。

• 单行注释：

　　Python 使用井号#作为单行注释的符号#，语法格式为：

#使用print输出字符串
print("Hello World!")
print("C语言中文网")
print("http://c.biancheng.net/python/")
#使用 print输出数字
print(100)
print( 3 + 100 * 2)
print( (3 + 100) * 2 )

print("http://c.biancheng.net/python/")  #输出Python教程的地址
print( 36.7 * 14.5 )  #输出乘积
print( 100 % 7 )  #输出余数

• 多行注释

　　多行注释指的是一次性注释程序中多行的内容（包含一行）。
　　Python 使用三个连续的单引号'''或者三个连续的双引号"""注释多行内容，具体格式如下：

　　多行注释通常用来为 Python 文件、模块、类或者函数等添加版权或者功能描述信息。

 

'''
使用 3 个单引号分别作为注释的开头和结尾
可以一次性注释多行内容
这里面的内容全部是注释内容
'''

"""
使用 3 个双引号分别作为注释的开头和结尾
可以一次性注释多行内容
这里面的内容全部是注释内容
"""

 

 

 

　　

 

 

二、代码缩进规（包含快捷键）

和其它程序设计语言（如 Java、C 语言）采用大括号“{}”分隔代码块不同，Python 采用代码缩进和冒号（ : ）来区分代码块之间的层次。
在 Python 中，对于类定义、函数定义、流程控制语句、异常处理语句等，行尾的冒号和下一行的缩进，表示下一个代码块的开始，而缩进的结束则表示此代码块的结束。
注意，Python 中实现对代码的缩进，可以使用空格或者 Tab 键实现。但无论是手动敲空格，还是使用 Tab 键，通常情况下都是采用 4 个空格长度作为一个缩进量（默认情况下，一个 Tab 键就表示 4 个空格）。
例如，下面这段 Python 代码中（涉及到了目前尚未学到的知识，初学者无需理解代码含义，只需体会代码块的缩进规则即可）：

height=float(input("输入身高：")) #输入身高
weight=float(input("输入体重：")) #输入体重
bmi=weight/(height*height)       #计算BMI指数

#判断身材是否合理
if bmi<18.5:
    #下面 2 行同属于 if 分支语句中包含的代码，因此属于同一作用域
    print("BMI指数为："+str(bmi)) #输出BMI指数
    print("体重过轻")
if bmi>=18.5 and bmi<24.9:
    print("BMI指数为："+str(bmi)) #输出BMI指数
    print("正常范围，注意保持")
if bmi>=24.9 and bmi<29.9:
    print("BMI指数为："+str(bmi)) #输出BMI指数
    print("体重过重")
if bmi>=29.9:
    print(BMI指数为："+str(bmi)) #输出BMI指数
    print("肥胖")

对于 Python 缩进规则，初学者可以这样理解，Python 要求属于同一作用域中的各行代码，它们的缩进量必须一致，但具体缩进量为多少，并不做硬性规定。

 

三、Python编码规范（PEP 8）

 

对比图 1 中的两段代码你会发现，它们所包含的代码时完全相同的，但很明显，右侧的代码编写格式看上去比左侧的代码段更加规整，阅读起来也会比较轻松、畅快，因为它遵循了最基本的 Python 代码编写规范。

Python 采用 PEP 8 作为编码规范，其中 PEP 是 Python Enhancement Proposal（Python 增强建议书）的缩写，8 代表的是 Python 代码的样式指南。下面仅给大家列出 PEP 8 中初学者应严格遵守的一些编码规则：

1. 每个 import 语句只导入一个模块，尽量避免一次导入多个模块，例如：
   

   #推荐
   import os
   import sys
   #不推荐
   import os,sys

2. 不要在行尾添加分号，也不要用分号将两条命令放在同一行，例如：
   

   #不推荐
   height=float(input("输入身高：")) ; weight=fioat(input("输入体重：")) ;

3. 建议每行不超过 80 个字符，如果超过，建议使用小括号将多行内容隐式的连接起来，而不推荐使用反斜杠 \ 进行连接。例如，如果一个字符串文本无法实现一行完全显示，则可以使用小括号将其分开显示，代码如下：
   
   注意，此编程规范适用于绝对大多数情况，但以下 2 种情况除外：
   • 导入模块的语句过长。
   • 注释里的 URL。
   
   

   #推荐
   s=("C语言中文网是中国领先的C语言程序设计专业网站，"
   "提供C语言入门经典教程、C语言编译器、C语言函数手册等。")
   #不推荐
   s="C语言中文网是中国领先的C语言程序设计专业网站，\
   提供C语言入门经典教程、C语言编译器、C语言函数手册等。"

4. 使用必要的空行可以增加代码的可读性，通常在顶级定义（如函数或类的定义）之间空两行，而方法定义之间空一行，另外在用于分隔某些功能的位置也可以空一行。比如说，在图 1 右侧这段代码中，if 判断语句同之前的代码多实现的功能不同，因此这里可以使用空行进行分隔。
5. 通常情况下，在运算符两侧、函数参数之间以及逗号两侧，都建议使用空格进行分隔。