如何在单行ReST文档字符串中指定返回类型并描述返回值？及缩写疑问

咱来逐个解决你这两个ReST文档字符串的问题：

1. 单行ReST文档字符串中指定返回类型并描述返回值 #

在单行ReST文档字符串里，你可以直接把:rtype和:returns标记放在字符串末尾，和函数描述连在一起。比如：

def get_flag_state() -> bool:
    """Retrieve the current flag status.:rtype: bool:returns: True if flag is active, False otherwise"""

要是觉得太挤，加几个空格分隔开可读性会更好：

def get_flag_state() -> bool:
    """Retrieve the current flag status. :rtype: bool :returns: True if flag is active, False otherwise"""

核心就是保持ReST的标记格式正确，主流文档工具（比如Sphinx）都能正确解析返回类型和描述内容。

2. 能否用类似参数的缩写方式处理多行返回注释？ #

当然可以！就像你把:type和:param合并成:param bool flag: new value for the flag一样，返回的标记也能做完全类似的合并。

原来的多行写法：

"""
:rtype: bool
:returns: new value of flag
"""

可以直接缩写成单行的：

""":returns bool: new value of flag"""

这种写法和参数的缩写逻辑完全一致，不管是Sphinx还是pdoc这类文档生成工具，都能正确识别这个格式，解析出返回类型和对应的描述内容，亲测好用！

内容的提问来源于stack exchange，提问作者user7610