使用Python编写document()函数轻松生成文档

编写一个document()函数可以帮助用户轻松生成文档，并且提供使用例子。下面是一个实现的示例代码：

def document(title, description, examples):
    """
    生成文档的函数，包括标题、描述和使用例子

    参数:
    title (str): 文档的标题
    description (str): 文档的描述
    examples (dict): 使用例子，键是例子的标题，值是例子的描述

    返回:
    str: 生成的文档字符串
    """
    # 生成标题部分
    doc_string = f"## {title}

"
    
    # 生成描述部分
    doc_string += f"{description}

"

    # 生成使用例子部分
    doc_string += "使用例子:
"
    for example_title, example_description in examples.items():
        doc_string += f"### {example_title}

"
        doc_string += f"{example_description}

"

    return doc_string

使用例子：

title = "使用document()函数生成文档"
description = "这是document()函数的使用例子"
examples = {
    "示例1": "这是      个示例",
    "示例2": "这是第二个示例",
    "示例3": "这是第三个示例"
}

doc = document(title, description, examples)
print(doc)

输出结果：

## 使用document()函数生成文档

这是document()函数的使用例子

使用例子:
### 示例1

这是      个示例

### 示例2

这是第二个示例

### 示例3

这是第三个示例

通过调用document()函数，可以方便地生成文档，并且提供使用例子，使得文档更加详细和易于理解。用户只需提供标题、描述和使用例子，即可得到一个完整的文档字符串。