python文档字符串
文档字符串，顾名思义，就是用来做文档的字符串。这个文档可不是word文档啊！文档字符串是这个函数的帮助文档，是用来提示使用者如何使用这个函数的。同时，一些自动化的工具，比如Python发行版附带的pydoc命令可以根据文档字符串快速创建程序的帮助文档。
在def定义一个函数之后，函数体的第一行可以说字符串，这个字符串就是文档字符串了。话不多说，直接上代码。
def add(x, y):
"""
返回参数x和参数y的两数之和
Parameters
---------
:param x: int
第一个参数
:param y: int
第二个参数
Returns
-------
:return: int
返回x+y
"""
return x+y
print(add(1, 2))
print(add.__doc__)执行结果如下:
3
返回参数x和参数y的两数之和
Parameters
---------
:param x: int
第一个参数
:param y: int
第二个参数
Returns
-------
:return: int
返回x+y这样，使用者就可以知道该怎么使用这个函数了。
当然，获取文档的方法还有另外一种，就是使用help()方法
help(add)执行结果如下
Help on function add in module __main__:
add(x, y)
返回参数x和参数y的两数之和
Parameters
---------
:param x: int
第一个参数
:param y: int
第二个参数
Returns
-------
:return: int
返回x+y这就是文档字符串的一些介绍了
本文参与 腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。
原始发表：2020年7月28日2，如有侵权请联系 cloudcommunity@tencent.com 删除
评论
登录后参与评论
推荐阅读
腾讯云开发者
