python哲学内容 多行胜于单行_Python3基础 __doc__ 单行与多行函数文档

Python : 3.7.0

OS : Ubuntu 18.04.1 LTS

IDE : PyCharm 2018.2.4

Conda : 4.5.11

typesetting : Markdown

code

"""

@Author : 行初心

@Date : 18-9-24

@Blog : www.cnblogs.com/xingchuxin

@Gitee : gitee.com/zhichengjiu

"""

def fun_single_doc(num):

" 单行函数文档 "

# pycharm会提示：使用 """ 代替 "

return num + 1

def fun_multiple_doc():

"""

多行的函数文档

单行文档不好，推荐使用多行的函数文档。

pycharm有快捷键ctrl+q，可以快捷查看函数的说明信息。

"""

def main():

print(fun_single_doc.__doc__)

print(fun_multiple_doc.__doc__)

if __name__ == '__main__':

main()

result

/home/coder/anaconda3/envs/py37/bin/python /home/coder/PycharmProjects/basic/demo.py

单行函数文档

多行的函数文档

单行文档不好，推荐使用多行的函数文档。

pycharm有快捷键ctrl+q，可以快捷查看函数的说明信息。

Process finished with exit code 0

resource

[文档] docs.python.org/3

[规范] www.python.org/dev/peps/pep-0008

[规范] zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_language_rules

[源码] www.python.org/downloads/source

[ PEP ] www.python.org/dev/peps

[平台] www.cnblogs.com

[平台] gitee.com

Python具有开源、跨平台、解释型、交互式等特性，值得学习。

Python的设计哲学：优雅，明确，简单。提倡用一种方法，最好是只有一种方法来做一件事。

代码的书写要遵守规范，这样有助于沟通和理解。

每种语言都有独特的思想，初学者需要转变思维、踏实践行、坚持积累。