位置: 编程技术 - 正文
Python中的多行注释文档编写风格汇总
编辑：rootadmin推荐整理分享Python中的多行注释文档编写风格汇总，希望有所帮助，仅作参考，欢迎阅读内容。
文章相关热门搜索词:,内容如对您有帮助，希望把文章链接给更多的朋友！
什么是docstring
在软件工程中，其实编码所占的部分是非常小的，大多是其它的事情，比如写文档。文档是沟通的工具。 在Python中，比较推崇在代码中写文档，代码即文档，比较方便，容易维护，直观，一致。 代码写完，文档也出来了。其实Markdown也差不多这种思想，文本写完，排版也完成了。 看看PEP 中对docstring的定义：
A docstring is a string literal that occurs as the first statement in a module, function, class, or method definition. Such a docstring becomes the __doc__ special attribute of that object.简单来说，就是出现在模块、函数、类、方法里第一个语句的，就是docstring。会自动变成属性__doc__。
可通过foo.__doc__访问得到' This is function foo'.
各类docstring风格：
Epytext
这是曾经比较流行的一直类似于javadoc的风格。
reST
这是现在流行的一种风格，reST风格，Sphinx的御用格式。我个人也是喜欢用这种风格，比较紧凑。
Google风格
Numpydoc (Numpy风格)
docstring工具之第三方库pyment
用来创建和转换docstring. 使用方法就是用pyment生成一个patch，然后打patch。
详情： 首先编辑conf.py文件， 1. 要有'sphinx.ext.autodoc'这个extensions 2. 确保需要自动生成文档的模块可被import，即在路径中。比如可能需要sys.path.insert(0, os.path.abspath(‘../..'))
然后，编写rst文件，
敲make html命令，就可以从docstring中生成相关的文档了，不用多手写一遍rst. 看效果：最大K个数问题的Python版解法总结 TopK问题,即寻找最大的K个数,这个问题非常常见,比如从1千万搜索记录中找出最热门的个关键词.方法一:先排序,然后截取前k个数.时间复杂度：O(n*logn)+O(k
实例讲解Python中global语句下全局变量的值的修改 Python的全局变量：intstring，list，dic(map)如果存在global就能够修改它的值。而不管这个global是否是存在于if中，也不管这个if是否能够执行到。但是，如果
从局部变量和全局变量开始全面解析Python中变量的作用域 理解全局变量和局部变量1.定义的函数内部的变量名如果是第一次出现，且在=符号前，那么就可以认为是被定义为局部变量。在这种情况下，不论全局
上一篇：Python构造自定义方法来美化字典结构输出的示例(python中创建自定义函数)
下一篇：最大K个数问题的Python版解法总结(最大的k个数python)
![[转]Accesskey引起的一点点思考(accessviolation怎么解决)](https://www.jiuchutong.com/image/20240129/1706503442.jpg)
