不使用 "'''
" 书写注释块
不要使用三引号去注释代码。 这不是好的实践,因为面向行的命令行工具,比如说grep,不会知道注释过的代码是没有激活的。对每一个注释行,使用带有合适缩进的井号会更好。您的编辑器可能很容易做到这一点,并能切换注释/取消注释。
注释风格
Numpy style
def random_number_generator(arg1,arg2):
"""
摘要行。
扩展功能描述。
参数
----------
arg1:int
arg1的描述
arg2:str
arg2的描述
返回
-------
int
返回值说明
"""
return 42