DocStrings

DocStrings

Python有一个甚是优美的功能称作文档字符串（Documentation Strings），在称呼它时通常会使用另一个短一些的名字docstrings。
DocStrings是一款你应当使用的重要工具，它能够帮助你更好地记录程序并让其更加易于理解。
令人惊叹的是，当程序实际运行时，我们甚至可以通过一个函数来获取文档！

[root@db01 ~]# vim 1.py
#!/usr/bin/env python3
def print_max(x, y):
    '''
    打印两个数值中的最大数，
    这两个数都应该是整数。
    '''
    # 如果可能，将其转换至整数类型
    x = int(x)
    y = int(y)

    if x > y:
        print(x, 'is maximum number')
    else:
        print(y, 'is maximum number')

print_max(3, 5)
print(print_max.__doc__)


[root@db01 ~]# python3 1.py 
5 is maximum number

    打印两个数值中的最大数，
    这两个数都应该是整数。
    
[root@db01 ~]#