Python基础03 注释

作者：玉树【林】风

转自：http://techlin.cn

欢迎转载，也请保留这段声明。

 

注释的作用

编码时，清晰明确的注释可以使我们在维护代码时能够更快的了解代码的作用。

# 获取数字的符号
def getSign(number):
    if number > 0:
        return 1
    elif number < 0:
        return -1
    elif number == 0:
        return 0

如果上面的函数没有注释，那么我们需要花一些时间来确认函数的作用，如果函数十分复杂，那么我们需要花费很多的时间来明确这个函数的用途。由此可见，注释可以提高阅读代码的效率，降低维护代码的成本。

 

单行注释

在代码中单行注释是比较简单和常用的，只需要简单的在注释内容前添加#号即可。

# 函数注释
deftest():
    str1='Hello'        # 变量注释
    str2='World!'       # 变量注释
 
    # 控制台输出Hello World!
    print(str1,str2)

带代码行中#号后面的所有内容均为注释内容

 

多行注释

当我们的注释内容比较多，全部写在一行中既不美观，也不优雅。这时我们就需要使用多行注释了。

'''
作者：XXX
功能：XXX
版本：1.0
日期：2017-01-01
'''
defxxx():
    ...

这里使用三个单引号（或双引号）将注释内容包裹即可。

 

总结

这节课中，我们学习了python的注释。

其中包括单行注释和多行注释2中注释。