[解決済み] パラメータを持つメソッドを文書化する方法は？

質問

Pythonのドキュメント文字列を使って、パラメータ付きのメソッドをドキュメント化する方法は？

EDITです。 PEP 257 には、こんな例があります。

def complex(real=0.0, imag=0.0):
    """Form a complex number.

    Keyword arguments:
    real -- the real part (default 0.0)
    imag -- the imaginary part (default 0.0)

    """
    if imag == 0.0 and real == 0.0: return complex_zero
    ...

Pythonの開発者の多くは、このような規約を使用しているのでしょうか？

Keyword arguments:
<parameter name> -- Definition (default value if any)

というような、もう少しフォーマルなものを想像していました。

def complex(real=0.0, imag=0.0):
    """Form a complex number.

    @param: real The real part (default 0.0)
    @param: imag The imaginary part (default 0.0)

    """
    if imag == 0.0 and real == 0.0: return complex_zero
    ...

環境 : Python 2.7.1

解決するには？

私の経験では numpy docstring conventions (PEP257のスーパーセット)は、最も広く普及している 続く などのツールでもサポートされている規約です。 スフィンクス .

一例です。

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