代码之家  ›  专栏  ›  技术社区  ›  user32882

如何以pep8格式docstring包含输出数据

  •  0
  • user32882  · 技术社区  · 7 年前

    根据python样式指南,标准pep8 docstring可以如下所示:

    """Function description
    
    Keyword arguments:
    keyword_arg_1 -- description
    keyword_arg_2 -- description
    """
    

    然而,在返回的输出数据标准中,我看不到任何东西,并且我认为这是函数定义的重要部分。i、 我想记录每个变量前面都有一个 return

    1 回复  |  直到 7 年前
        1
  •  1
  •   enamoria    7 年前

    既然您使用的是pycharm,那么只需定义函数并放入3 " def ,按enter键,它会自动为您生成docstring,包括返回数据。您也可以选择多达5个docstring格式,由转到 Settings > Tools > Python Integrated Tools > Docstring format . 我不知道我们是否可以定制,但我认为他们提供的是足够的
    enter image description here

    推荐文章