```python """ 这是一个简单的Python函数，用于计算两个数字的和。

参数： num1 (int): 第一个数字。 num2 (int): 第二个数字。

返回值： int: 两个数字的和。 """ def sum_two_numbers(num1, num2): """计算两个数字的和。

Args:
    num1 (int): 第一个数字。
    num2 (int): 第二个数字。

Returns:
    int: 两个数字的和。

Examples:
    >>> sum_two_numbers(1, 2)
    3
    >>> sum_two_numbers(-1, 1)
    0
"""
return num1 + num2

```

函数说明

该文档描述了一个名为 sum_two_numbers 的 Python 函数。

• 函数功能: 计算两个数字的和。
• 参数: 函数接受两个整数参数 num1 和 num2。
• 返回值: 函数返回两个数字的和，也是一个整数。

文档格式

该文档使用 Markdown 格式，包含以下部分：

• 函数说明: 简要描述函数的功能。
• 参数: 列出函数的参数，包括参数名称和数据类型。
• 返回值: 描述函数的返回值类型。
• 示例: 展示函数的使用示例，包括输入和输出。

使用方法

以下示例演示了如何使用 sum_two_numbers 函数：

```python

计算 1 和 2 的和

result = sum_two_numbers(1, 2) print(result) # 输出: 3

计算 -1 和 1 的和

result = sum_two_numbers(-1, 1) print(result) # 输出: 0 ```

总结

该文档提供了 sum_two_numbers 函数的详细说明，包括函数功能、参数、返回值和使用示例。希望这份文档对您理解和使用该函数有所帮助。