Python:pycharm的docstring注释文档字符串风格

22 篇文章 2 订阅

设置位置:
Tools -> Python Integrated Tools -> Docstrings -> Docstring format

五种风格:

  1. Plain
  2. reStructuredText
  3. Numpy
  4. Google
  5. Epytext

风格示例


# Plain
def foo1(a, b):
    """

    """
    return a+b

# reStructuredText
def foo2(a, b):
    """
    :param a:
    :param b:
    :return:
    """
    return a+b

# Numpy
def foo3(a, b):
    """
    Parameters
    ----------
    a
    b

    Returns
    -------

    """
    return a+b

# Google
def foo4(a, b):
    """
    Args:
        a:
        b:

    Returns:

    """
    return a + b

# Epytext
def foo(a, b):
    """
    @param a:
    @param b:
    @return:
    """
    return a+b

  • 6
    点赞
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值