【Py】关于Python docstring几种主流风格

最新推荐文章于 2025-09-30 23:56:54 发布

原创

最新推荐文章于 2025-09-30 23:56:54 发布 · 3.2k 阅读

5 ·

CC 4.0 BY-SA版权

文章标签：

#python #docstring #sphinx #napoleon

本文介绍了Python中不同的函数注释格式，包括reST、Epytext、Google风格及Numpydoc等，并对比了它们之间的区别。

今天在整理Python文档的时候，发现除了目前在用的如下格式外，还有很多种。就简单整理一下。

def foo(bar: str) -> str:
    """
    foo function
    
    :param str bar: bar
    :return: return bar
    :rtype: str
    """
    return bar

目前流行的格式有如下几种，我之前用的属于reST，是目前最广泛的一种方式，是Sphinx原生支持的格式。还有Epytext，好像是从Java那来的。如果你在Swagger Codegen上生成过Python 代码会发现其中的格式也是reST。还有一种比较流行的是Google自家用的格式，貌似更简洁一些，格式可以参考这里。Numpy团队在Google