Python文档字符串是自由形式的，你可以用任何你喜欢的方式来记录它。

例子:

def mymethod(self, foo, bars):
    """
    Does neat stuff!
    Parameters:
      foo - a foo of type FooType to bar with.
      bars - The list of bars
    """

现在，有一些约定，但是python没有强制执行它们。有些项目有自己的约定。一些处理文档字符串的工具也遵循特定的约定。

文档字符串只在交互环境中有用，例如Python shell。当记录那些不会被交互使用的对象(例如内部对象，框架回调)时，你最好使用常规注释。下面是我用来将缩进的注释挂在项目上的一种风格，每个注释都在自己的行上，这样你就知道注释应用于:

def Recomputate \
  (
    TheRotaryGyrator,
      # the rotary gyrator to operate on
    Computrons,
      # the computrons to perform the recomputation with
    Forthwith,
      # whether to recomputate forthwith or at one's leisure
  ) :
  # recomputates the specified rotary gyrator with
  # the desired computrons.
  ...
#end Recomputate

你不能用文档字符串做这种事情。

Python文档字符串是自由形式的，你可以用任何你喜欢的方式来记录它。

例子:

def mymethod(self, foo, bars):
    """
    Does neat stuff!
    Parameters:
      foo - a foo of type FooType to bar with.
      bars - The list of bars
    """

现在，有一些约定，但是python没有强制执行它们。有些项目有自己的约定。一些处理文档字符串的工具也遵循特定的约定。

由于文档字符串是自由形式的，因此它实际上取决于您使用什么来解析代码以生成API文档。

我建议熟悉Sphinx标记，因为它被广泛使用，并且正在成为记录Python项目的事实上的标准，部分原因是出色的readthedocs.org服务。将Sphinx文档中的一个示例改写为Python代码片段:

def send_message(sender, recipient, message_body, priority=1) -> int:
   """
   Send a message to a recipient.

   :param str sender: The person sending the message
   :param str recipient: The recipient of the message
   :param str message_body: The body of the message
   :param priority: The priority of the message, can be a number 1-5
   :type priority: integer or None
   :return: the message id
   :rtype: int
   :raises ValueError: if the message_body exceeds 160 characters
   :raises TypeError: if the message_body is not a basestring
   """

该标记支持文档之间的交叉引用。请注意，Sphinx文档使用(例如):py:attr:，而当从源代码中进行记录时，您可以只使用:attr:。

当然，还有其他工具可以记录api。还有更经典的Doxygen，它使用\param命令，但它们不像Sphinx那样专门用于记录Python代码。

注意，这里有一个类似的问题和类似的答案……

约定:

PEP 257文档字符串约定 PEP 287 reStructuredText文档字符串格式

工具:

Epydoc:为Python自动生成API文档 autodoc -包括文档字符串中的文档 PyCharm对文档字符串有一些很好的支持

更新:从Python 3.5开始，你可以使用类型提示，这是一种紧凑的、机器可读的语法:

from typing import Dict, Union

def foo(i: int, d: Dict[str, Union[str, int]]) -> int:
    """
    Explanation: this function takes two arguments: `i` and `d`.
    `i` is annotated simply as `int`. `d` is a dictionary with `str` keys
    and values that can be either `str` or `int`.

    The return type is `int`.

    """

这种语法的主要优点是它是由语言定义的，并且是明确的，因此像PyCharm这样的工具可以很容易地利用它。

根据我的经验，numpy文档字符串约定(PEP257超集)是最广泛遵循的约定，Sphinx等工具也支持这些约定。

一个例子:

Parameters
----------
x : type
    Description of parameter `x`.