DocStrings 文档å—符串是一个é‡�è¦�工具,用于解释文档程åº�ï¼Œå¸®åŠ©ä½ çš„ç¨‹åº�æ–‡æ¡£æ›´åŠ ç®€å�•易懂。
我们å�¯ä»¥åœ¨å‡½æ•°ä½“的第一行使用一对三个å�•引å�· ''' 或者一对三个å�Œå¼•å�· """ æ�¥å®šä¹‰æ–‡æ¡£å—符串。
ä½ å�¯ä»¥ä½¿ç”¨ __doc__(注æ„�å�Œä¸‹åˆ’线)调用函数ä¸çš„æ–‡æ¡£å—符串属性。
#!/usr/bin/python
# -*- coding: UTF-8 -*-
def function():
''' say something here�
'''
pass
print (function.__doc__) # 调用 doc
输出结果为:
say something here�
DocStrings 文档å—符串使用惯例:它的首行简述函数功能,第二行空行,第三行为函数的具体æ��述。
#!/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 最大
打å�°ä¸¤ä¸ªæ•°ä¸çš„æœ€å¤§å€¼ã€‚
两个值必须都是在整形数。
点我分享笔记