第二章--第二节：注释

零、怎么编写注释

编写注释的方式有三种： 1.以 # 开头 2.以三个 ’ 开头和结尾 3.以三个 " 开头和结尾

# 定义一个字符串变量
name = '张三'


# 定义一个函数
def GetName():
    return name


def SetName(n):
    '''
    :param n: 姓名
    :return:
    '''
    name = n


def SetAge(age):
    """
    :param age: 年龄
    :return:
    """
    return age

单引号和双引号注释中出现了**:para 参数名:和return:**，param是对每个参数的描述，return是对返回值的描述

一、规则

注释具有两个功能： 1.对所编写的代码解释说明 2.表明编写代码的思路 结合以上两点，我们在编写代码的时候应遵循 简单、明了 。所谓简单明了，就是指要用简练的语言清晰的描述出代码所要做的事情/编写代码的思路。还应注意的是，#注释一般用于函数/方法内的代码注释，单引号和双引号注释一般用于函数/类/方法本身的注释

二、 小结

本节主要讲解了注释的写法，请读者牢记注释的规则