Python编程基础与科学计算
上QQ阅读APP看书,第一时间看更新

1.6 Python编程的注意事项

1.6.1 空行与注释

为了增加程序的可读性和显得美观,在不同功能的代码之间定义一行或两个空行,Python解释器会忽略空行。在两个自定义函数(def)之间、在import语句与主代码之间都可以增加空行。

为了增加程序的可读性,或者让其他编程人员容易理解程序,在程序中往往需要增加注释,对于一个优秀的程序员而言,为代码添加注释是其必要的工作内容。Python的注释可以是单行注释,也可以是多行注释,Python解释器会忽略注释内容。Python注释除了可以起到说明文档的作用外,还可以进行代码的调试,将一部分代码注释掉,对剩余的代码进行排查,从而找出问题所在,进行代码的完善。

单行注释可以单独占用一行,也可以是在一行代码的右边加注释,以“#”作为注释的开始标识,“#”后面的内容都将作为注释内容。多行注释是用3个单引号(''' ''')或3个双引号(""" """),把注释的内容放到引号中间即可。在进行自定义函数(def)和类(class)定义时,在第2行添加注释,可以作为help(函数名)函数的返回值,或者用函数名.__doc__的方法获取注释信息,再用print()函数输出信息。例如下面的代码有单行注释、多行注释和空行。

运行程序后得到下面信息:

在Python的早期版本中进行Python开发时,须进行编码声明,如果代码中有中文,则需要采用UTF-8编码,须在代码第一行用#-*-coding:UTF-8-*-声明。从Python3开始,Python默认使用UTF-8编码,所以Python3.x的程序文件中不需要特殊声明UTF-8编码。