第四章 注释

1、注释

Python中有两种注释,单行或者多行。Python解释器忽略这部分内容不予执行。

  • 单行:使用#,#与注释之间留一个空格。一般跟在语句之后。If num in lists: # if lists contain num
  • 多行注释:使用文档字符串方式。

2、文件注释

在文件开始写下以下注释#!,目的就是指出,当前文件中的代码用什么可执行程序去运行它,推荐使用第二种方式。

#!/usr/bin/python 告诉os执行这个脚本的时候调用路径/usr/bin下的Python解释器。

#!/usr/bin/env python 告诉os在evn中查找Python的安装路径,然后使用其中的Python解释器执行当前脚本。

3、文档字符串

模块、类、函数的第一个逻辑行的字符串称为文档字符串(docstring)。必须处于def/class的第一行。可以是多行,也可以是单行。可以是单引号,也可以是双引号。但是开头和结尾必须保持一致。

Python使用文档字符串生成有关程序中函数、模块、类、方法的文档。

函数文档注释:func_name.__doc__

类的文档注释:ClassName.__doc__

4、编码

Python默认是ASCII编码,输出汉字有问题,在文件开头加入以下信息就可以完美解决:

# coding=utf-8 注意:=两侧不要留空格,#与coding之间留空格

# -*- coding: UTF-8 -*-

参考链接:https://www.python.org/dev/peps/pep-0263/

Python3默认使用的是UTF-8编码


分享到:


相關文章: