Python 在文档字符串中格式化 JSON答案

【问题标题】：Python formating JSON inside a docstringPython 在文档字符串中格式化 JSON
【发布时间】：2021-05-31 09:44:47
【问题描述】：

您好，我正在尝试在 Python 中创建这样的文档字符串：

    def hello_world_request(self, json):
    """
    foo
    Example JSON:
    
    {
        "helloWorld": [
            {
                "firstWord": "Hello",
                "lastWord": "World",
                "comment": "foo"
            }
        ]
    }

    :param json: json object
    """

查看下图，您可以看到文档。是否可以让文档字符串中的每一行在文档中也显示为单独的行？所以它看起来像函数的文档字符串。

【问题讨论】：

您是否尝试在字段之间输入另一条白线？顺便说一句，您也可以查看stackoverflow.com/questions/3953692/…
在 firstWord 和 lastWord 之间添加换行符是可行的，但是，这感觉像是一种 hack，而不是预期的方式。

标签： python json documentation

【解决方案1】：

想通了

   """
    foo
     .. code-block:: json

    {
        "helloWorld": [
            {
                "firstWord": "Hello",
                "lastWord": "World",
                "comment": "foo"
            }
        ]
    }

    :param json: json object
    """

【讨论】：