Python 文档示例

模块名称: my_utils

模块描述: 此模块包含一些实用函数，可用于各种任务。

函数:

• greet(name):
  • 参数:
    • name (str): 姓名
  • 返回值:
    • str: 打印问候语
  • 描述: 向指定姓名的人问好。

```python def greet(name): """ 向指定姓名的人问好。

Args: name: 姓名

Returns: 问候语。 """ return f"你好，{name}！" ```

• add(a, b):
  • 参数:
    • a (int/float): 第一个数字
    • b (int/float): 第二个数字
  • 返回值:
    • int/float: 两个数字的和
  • 描述: 返回两个数字的和。

```python def add(a, b): """ 返回两个数字的和。

Args: a: 第一个数字 b: 第二个数字

Returns: 两个数字的和。 """ return a + b ```

• is_even(num):
  • 参数:
    • num (int): 数字
  • 返回值:
    • bool: True 如果数字为偶数，否则为 False
  • 描述: 检查数字是否为偶数。

```python def is_even(num): """ 检查数字是否为偶数。

Args: num: 数字

Returns: 如果数字为偶数，则返回 True，否则返回 False。 """ return num % 2 == 0 ```

示例用法:

```python

问候用户

name = "Alice" print(my_utils.greet(name))

添加两个数字

a = 5 b = 10 print(my_utils.add(a, b))

检查数字是否为偶数

num = 6 print(my_utils.is_even(num)) ```

说明:

• 此模块仅提供了一些简单的示例函数。
• 您可以根据自己的需要添加更多函数。
• 使用文档字符串来描述每个函数的功能。

作者: [您的姓名]

版权: [版权信息]