从0开始的Python学习010return语句&DocStrings

return语句

---

return语句用来从一个函数中 返回 即跳出函数。当然也可以从函数中返回一个值。

#return 语句从一个函数返回 即跳出函数。我们也可选从函数返回一个值
def maximum(x,y):
    if x > y:
        return x
    else:
        return y

print(maximum(5,3))


def someFunction():
    pass

print(someFunction())

#注意，没有返回值的return语句等价于return None。None是Python中表示没有任何东西的特殊类型。例如，如果一个变量的值为None，可以表示它没有值。
#除非你提供你自己的return语句，每个函数都在结尾暗含有return None语句
#pass语句在Python中表示一个空的语句块。

运行结果

DocStrings

---

Python有一个很奇妙的特性，称为 文档字符串 ，它通常被简称为 docstrings 。DocStrings是一个重要的工具，由于它帮助你的程序文档更加简单易懂，你应该尽量使用它。

在函数的第一个逻辑行的字符串是这个函数的 文档字符串 。注意，DocStrings也适用于模块和类，我们会在后面相应的章节学习它们。

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

你可以使用__doc__（注意双下划线）调用printMax函数的文档字符串属性（属于函数的名称）。请记住Python把 每一样东西 都作为对象，包括这个函数。我们会在后面的类一章学习更多关于对象的知识。

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

def printMax(x,y):
    '''Prints the maximum of two numbers.
    The two values must be integers.'''
    x=int(x) # convert to integers, if possible
    y=int(y)
    if x>y:
            print(x,'is maximum')
    else:
            print(y,'is maximum')
printMax(3,5)
print (printMax.__doc__)

运行结果