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

Question

根据python样式指南，标准的pep8 docstring可能如下所示：

"""Function description

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

但是，在返回的输出数据的标准中，我什么都没看到，我认为这是函数定义的重要组成部分。即我想记录每个return语句之后的变量。

为python中每个返回的函数输出提供描述和类型的良好标准方法是什么？

Answer 1

由于您使用的是pycharm，只需定义函数并将3 "放在def之后，按Enter，它将自动为您生成文档字符串，包括返回数据。您还可以通过转到Settings > Tools > Python Integrated Tools > Docstring format选择最多5个文档字符串格式。我不知道我们是否可以自定义它，但我认为他们提供的内容就足够了