Python脚本的基本格式和文档字符串

cheng029

python脚本编写要遵循一定的规范，有单行注释、多行注释等多种注释方法

# cat stand.py

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

#!/usr/bin/python #coding=utf-8 #上面其实你随便怎么写都可以。只要符合coding[:=]\s*([-\w.]+) #比如这种写法：#  -*- coding: utf-8  -*-，如果有脚本中有中文，一定要用utf-8字符编码 "写在模块的第一行，就是这个模块的__doc__,这是一个标准块脚本的写作范式，此处为该脚本文档" print 'Hello world' print "中国人，你好"    "不写在模块的第一行，就是一个单行注释" #这里给下面语句做一个注释，这也是单行注释 new_str = "这是一个全局变量" #这样写注释也可以       def hello():     """     多行注释写在方法的第一行     就是一个DocString了     @author:     @copyrigth:     """     x=1     """     这是多行注释，写在这里就是多行注释了     不会被当成DocString     """     return "hello world hllo" #print hello() #写在这里，import的时候，会被执行 ##程序主体,程序的主体在import的时候不会被执行，只有当直接运行这个模块的时候才被执行，所以可以写很多测试代码 if __name__=="__main__":     print hello()     print hello() == "hello world" #测试

# cat import.py

1 2 3 4 5 6 7 8 9 10

#!/usr/bin/python #coding=utf-8 # 引入模块，不需要加.py,import 模块的时候，被引入的模块会被编译为pyc文件，而直接执行不会产生pyc文件 # 模块import的时候，排除程序主体以外的程序("__main__")，都会被从头到尾的执行一遍，但函数如不调用则不执行 import stand print stand.__doc__ print stand.new_str print stand.hello.__doc__ print help(stand)  #执行的时候按q退出 print help(stand.hello) #执行的时候按q退出

# python import.py
Hello world
中国人，你好
写在模块的第一行，就是这个模块的__doc__,这是一个标准块脚本的写作范式，此处为该脚本文档
这是一个全局变量

    多行注释写在方法的第一行
    就是一个DocString了
    @author:
    @copyrigth:



None

None

说明：
python的单行注释有:#  ""  ''
python的多行注释有：""" """

三个符合的区别 '',"",""" """
''和"" 没有区别，表示单行的字符串，""里面可以写’，''可以写""，不会引起编译器的混淆

"""
里面可以写多行的字符串，里面可以随便写单引号和双引号
"""

在函数的第一个逻辑行的字符串是这个函数的文档字符串 。
在模块的第一个逻辑行的字符串是这个模块的文档字符串 。

文档字符串的惯例是一个多行字符串，它的首行以大写字母开始，句号结尾。第二行是空行，从第三行开始是详细的描述。 强烈建议你在你的函数中使用文档字符串时遵循这个惯例。

你可以使用__doc__（注意双下划线）调用hello函数的文档字符串属性（属于函数的名称）。请记住Python把 每一样东西都作为对象，包括这个函数。

如果你已经在Python中使用过help()，那么你已经看到过DocStings的使用了！它所做的只是抓取函数的__doc__属性，然后整洁地展示给你。你可以对上面这个函数尝试一下——只是在你的程序中包括help(stand.hello)。记住按q退出help。

自动化工具也可以以同样的方式从你的程序中提取文档。因此，强烈建议 你对你所写的任何正式函数编写文档字符串。随你的Python发行版附带的pydoc命令，与help()类似地使用DocStrings。
代码要多写注释，看别人的程序首先应该看的就是注释，然后才是代码