第4.5节 缩进、注释、文档字符串及标识符

一、 关于源文件的缩进使用
        前面关于语句中冒号使用有类似“每个关键词语句后面必须有冒号,每个执行内容必须缩进4个空格”这样的内容,经过近段时间的学习,这个说法并不完全正确。
正确的说法是:冒号后面的执行代码可以在该语句后面不换行继续,也可以在该行后换行后继续。当不换行时,就表示该后的执行语句只能是一条;如果换行,则可以是一行或多行,这些行构成的代码块必须相比冒号所在行进行缩进,缩进最好是4个空格。
举例:
d={'name':'张三','grade':'3年级'}
i,k,v=d.items(),d.keys(),d.values()
k=for kk in k:print(type(kk),kk,sep=':  ')

二、 关于注释及文档字符串
     前面对注释有“Python中注释使用#开头,只能做单行注释,如果是多行,可以采用每行加#号”,其实这个说法也不完全正确。
该说法只是一种常用的注释行为,还有一种注释的使用方法,就是直接使用字符串,如果涉及多行字符串,则用三引号(三个单引号或三个双引号)标记起来。这种注释使用方法,一般用于在def语句后面以及模块和类的开头。
      放在函数开头的字符串称为文档字符串(docstring),将作为函数的一部分存储起来。可以用:函数名. __doc__访问这些文档字符串,特殊的内置函数help可使用它获取有关函数的信息,其中就包含函数的文档字符串。
举例:
 
def week(weekday):   #定义函数
    '''
    函数传入1-7表示星期几的日子,输出英文单词的对应周时间的名字
    如果输入数据不是1-7,则返回报错信息
    '''
    if not 0<weekday<8: 
            return 'The day must be 1-7,but now is :'+ str(weekday)
    else:
        return ['monday','tuesday','wendsday','thursday','friday','saturday','sunday'][weekday-1]

help(week)   #查看函数的帮助,输出如下内容:
Help on function week in module __main__:

week(weekday)
    函数传入1-7表示星期几的日子,输出英文单词的对应周时间的名字
    如果输入数据不是1-7,则返回报错信息

很有意义的文档字符串,对于提高程序的用户友好性非常有用。二、   Python标识符
1.    在Python中,名称(标识符)被用于变量名、函数名、方法名、属性名等,名称(标识符)只能由字母、数字和下划线(_)构成,且不能以数字打头;
2.    变量可将其视为指向值的名称,在代码运行过程中,对应的变量就存在本地名字空间这个字典内,可以通过本地名字空间访问这些变量。在Python中有一个名为vars的内置函数,它返回的值与locals函数返回值相同,二者是等价的。

    本节对Python缩进、注释有关的解释进行了修订,并介绍了文档字符串、标识符及变量相关的内容。
    老猿Python(https://blog.csdn.net/LaoYuanPython)系列文章用于逐步介绍老猿学习Python后总结的学习经验,这些经验有助于没有接触过Python的程序员可以很容易地进入Python的世界。 
欢迎大家批评指正,谢谢大家关注!

原文地址:https://www.cnblogs.com/LaoYuanPython/p/11087727.html