11. 注释

注释简介

  注释是代码文件中用于解释说明的文字，它不属于程序代码，它的有无对程序是否能正确运行没有影响，但可以用人类语言阐明代码要义，使代码更便于阅读与理解。正规的程序中，注释是不可或缺的。
  注释有两种模式，一种是用三引号（单引号或双引号），适用于多行注释，可参考《2. print的应用(1)》中三引号的使用；另一种是用**#**开始，适用于单行注释。

"""
作者：Jacques/CS
功能：几何图形面积计算
日期：2020/05/21
"""
def trapezoid_area(top_base, bottom_base, height):
    """
    此函数用于计算梯形的面积
    :param top_base: 梯形的上底
    :param bottom_base: 梯形的下底
    :param height: 梯形的高
    :return: 梯形的面积
    """
    area = (top_base + bottom_base) * height / 2  # 梯形的面积公式
    return area
# 调用函数计算梯形面积并打印
area_temp = trapezoid_area(3, 4, 5)
print(area_temp)

  上面的例子是一个.py文件，开始处对文件进行了简要说明。中间是函数定义，在函数名下面插入了对函数的说明（只要在那里输入三引号，回车后Pycharm会自动生成一些文字）。另外还有两处单行注释。

代码屏蔽

  在开发过程中，有一些代码语句可能临时不用，又不能删除，留在程序中会造成干扰，这时最恰当的方法就是将其屏蔽掉，这就和注释很相似了。通用方法是使用#将后面的代码屏蔽，如果需要被屏蔽的代码有多行，可以用光标选中多行代码，按住Ctrl键，然后按 /，这样每一行前面都会出现一个#；如果需要为多行代码取消屏蔽，操作是相同的，选中多行，再用Ctrl+/组合，就可以取消屏蔽了。