PyCharm，当我开始输入文档字符串时，Python IDE 会为文档字符串生成一个模板。这是为一个简单函数生成的模板。
def add_them(x, y):
"""
:param x:
:param y:
:return:
"""
z = x + y
return z
我没有发现它与 Python 的官方文档字符串 conventions 相似。
这个模板对 readthedocs 这样的文档生成器有什么用吗？
人们如何有效地使用？
填充模板的正确方法是什么？
谢谢。
【问题讨论】：
标签： python coding-style documentation pycharm docstring
我们将它与 sphinx-apidoc 一起使用来生成我们的 HTML 和 PDF 文档。
这是我如何使用文档字符串的示例：
def add_pdr(process, userid, log):
""" Create and perform the target account operation PDR
If the function/method is complex, I'd put a short one-line
summary in the first line above, and a more detailed explanation
here.
:param dict process: dict of process details
:param str userid: userid to perform actions on
:param obj log: log object to perform logging to
:raises KeyError: if the userid doesn't exist
:raises APIError: if process dict is invalid
:return: True on success, False upon failure
"""
【讨论】：
exception 的例子更新答案吗？
:rtype 来指定返回变量的类型？
:rtype。