Python数据挖掘教程-第3天(4):注释
程序员文章站
2022-05-25 13:01:05
...
代码中的注释,在程序执行时会被忽略,主要是为了向协作者和未来的自己说明代码的思路、功能。我们在注释时应假设阅读者比我们的Python水平要高,阅读注释只是为了更快地理解代码要做什么,切忌直接描述代码。另外,注释也不宜过多,一般占到源代码的1/3左右是比较合适的。
在Python中,主要有两种注释的方法,分别为单行注释和多行注释。
单行注释使用#
标记,可以单作一行,也可以用在其他行的结尾,这类注释主要用来解释一段代码(单作一行的情况)或用来解释该行代码的作用。为了提高可读性,放在行尾的注释距离代码至少间隔2个空格以上。
# 这是一段单行注释
print("Hello World") # 这也是一段单行注释
多行注释前后使用"""
或'''
标记,这类注释主要用来解释类、函数、文件等。在类的注释中,一般包括作者(@author)、属性(@param)等;在函数的注释中,一般包括作者(@author)、参数(@param)、返回值(@return)以及抛出的异常(@raises)等。
"""
这是一段多行注释
"""
"""多行注释也可以是这样的"""
上一篇: message