如何用参数记录方法？
如何使用Python的文档字符串使用参数记录方法？
编辑： 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的文档字符串公约（PEP257超集）是最广泛的传播 遵循 惯例，它们也通过工具，如支持的狮身人面像。
一个例子：
Parameters
----------
x : type
Description of parameter `x`.
-
问题内容： 使用，如何记录参数并抛出异常？ 我找不到任何方法。 我应该使用？ 问题答案： 有没有办法把两者以中。 我会转换为并使用： 您还可以创建log指向的自己的方法，例如：
-
当参数类型可以混合时，如何使用JSDoc在JavaScript中记录方法？ 我有一个对话框对象的方法，我可以显示HTML或我自己的可视对象。JSDoc方法如下所示： 因为JS不允许方法重载，所以我需要创建这些类型的方法，其中方法中的参数可以是两种不同的类型。有没有办法在JSDoc中记录这一点，或者JSDoc只能让你记录一种类型的参数？ 另外，您将如何记录类型的参数？也就是说，传入的对象不是类型。准
-
Swashbuckle在提取C# XML注释以制作Swagger API文档方面做得很好。Swagger 支持记录查询字符串参数。但是，如果有一种方法可以在XML中记录查询字符串参数，以便Swashbuckle导出它们，我还没有找到它。 我有这样的东西： 并且＜code＞搜索＜/code＞不会显示在输出中。我尝试删除＜code＞没有帮助。我怀疑XML注释不直接支持这一点。如果这是真的，我正在寻找一
-
给定以下代码，如何使用最新的JSDoc正确记录它？ 我尝试过这个： 显然这不起作用，JSDoc留档提到的只是如何记录去结构化对象参数，而不是去结构化数组参数。
-
我有多个方法做基本相同的事情，接收一个对象，将字段传递给查询并返回结果。
-
问题内容： 我已经开始在一个拥有数以百计的表和视图的数据库的地方工作，所有这些表和视图都具有隐秘的名称，只有很少的元音，并且没有文档。它们也不允许对数据库架构进行无谓的更改，我也不能触摸任何数据库，除非要在我自己的计算机上进行测试（该数据库会被删除并定期重新创建），因此我无法添加对任何人都有用的注释。 我尝试使用“ Toad”创建一个ER图，但是连续运行48小时后，它仍然看不到任何可见的东西，我需