# 这是python的单行注释
这是多行注释
这是多行注释
与常规注释不同,docstring是作为它们所记录的函数的属性存储的,这意味着您可以通过编写程程序访问它们。
def func():
"""这是一个函数的注释说明"""
return
这个注释字符串,可以通过函数属性doc来访问。
print(func.__doc__)
运行程序后,输出:
这是一个函数的注释说明
在函数中不添加docstring或常规注释就会大大降低它的帮助。例如:
def greet(name, greeting="Hello"):
# Print a greeting to the user `name`
# Optional parameter `greeting` can change what they're greeted with.
print("{} {}".format(greeting, name))
print(greet.__doc__)
运行上面的代码,就会输出:
None
help(greet)
Help on function greet in module main: greet(name,greeting='Hello')
docstring是一个多行注释,用于记录模块、类、函数和方法。它必须是它所描述的组件的第一个语句。
def help(name):
"""
Greet someone.
Print a greeting("Hello") for the person with the given name.
"""
print("Hello " +name)
class Greeter:
"""
An object used for greet people.
It contains multiple greeting functons for servral languages and times of the day.
"""
print(hello.__doc__)
print(Greeter.__doc__)
运行后,分别输出:
Greet someone. Print a greeting("Hello") for the person with the given name.
An object used for greet people. It contains multiple greeting functons for servral >languages and times of the day.
如果觉得内容还不错,分享给更多朋友,一起提升编程技能。