一.文档字符串
参考网站:
https://blog.csdn.net/wgw335363240/article/details/25716395
函数用def关键字定义,然后函数名和圆括号(),括号内有参数和自变量,函数体要缩进。
函数下的第一行,可以是字符串,这个字符串急速文档字符串。
文档字符串(documentation string)简称docstrings,是用来说明函数功能的。
文档字符串的写法:
函数体下第一行是一对三个单引号(''')或者一对三个双引号(""")来定义文档字符串。
函数体的第一行是简述函数功能 ,第一个字母要大写,以句号(.)结束。
第二行是空行
第三行是 函数的具体描述 , 第一个字母要大写 。
你可以使用 __doc__(注意双下划线)调用函数中的文档字符串属性。
查看文档字符串:print(函数名.__doc__) ( 注意双下划线 )
实例:
#!/usr/bin/python
# -*- coding: UTF-8 -*-
def printMax(x,y):
'''打印两个数中的最大值。
两个值必须都是在整形数。'''
x=int(x)
y=int(y)
if x>y:
print(x,'最大')
else:
print(y,'最大')
printMax(3,5)
print (printMax.__doc__) # 调用 doc
输出结果为:
5 最大
打印两个数中的最大值。
两个值必须都是在整形数。
二.文档字符串和注释的区别
一般来说,文档字符串(docstring)偏向于对特定模组(module)、函数(function)、类(class)和方法(method)的一个总体介绍,更注重于告诉其他程序员应该怎么使用这些模组/函数/类/方法;
而注释(comment)则注重于记录代码实现的细节。