如何在 pep8 格式文档字符串中包含输出数据
How to include output data in pep8 format docstring
根据 python 风格指南的标准 pep8 文档字符串可能如下所示：
"""Function description
Keyword arguments:
keyword_arg_1 -- description
keyword_arg_2 -- description
"""
但是我在返回输出数据的标准中没有看到任何内容，我认为这是函数定义的重要部分。即我想记录每个变量前面有 return 语句。
在 python 中为每个返回的函数输出提供描述和类型的好的标准方法是什么？
由于您使用的是 pycharm，只需定义函数并将 3 " 紧跟在 def 之后，按回车键，它会自动为您生成文档字符串，包括 return 数据。您还可以 select 最多 5 种文档字符串格式，通过转到 Settings > Tools > Python Integrated Tools > Docstring format。不知道能不能定制，不过我觉得他们提供的已经足够了
根据 python 风格指南的标准 pep8 文档字符串可能如下所示：
"""Function description
Keyword arguments:
keyword_arg_1 -- description
keyword_arg_2 -- description
"""
但是我在返回输出数据的标准中没有看到任何内容，我认为这是函数定义的重要部分。即我想记录每个变量前面有 return 语句。
在 python 中为每个返回的函数输出提供描述和类型的好的标准方法是什么？
由于您使用的是 pycharm，只需定义函数并将 3 " 紧跟在 def 之后，按回车键，它会自动为您生成文档字符串，包括 return 数据。您还可以 select 最多 5 种文档字符串格式，通过转到 Settings > Tools > Python Integrated Tools > Docstring format。不知道能不能定制，不过我觉得他们提供的已经足够了