```python
```python """ 这是一个示例 Python 模块文档。
这个模块包含一些简单的函数,用来展示如何编写文档字符串。 """
def greet(name): """ 这个函数用来问候用户。
:param name: 用户的名字。 :type name: str :raises TypeError: 如果 name 不是字符串类型。 :returns: 一个问候字符串。 :rtype: str
greet("Alice") 'Hello, Alice!' """ if not isinstance(name, str): raise TypeError("name 必须是字符串类型") return f"Hello, {name}!"
def add(a, b): """ 这个函数用来计算两个数的和。
:param a: 第一个数。 :type a: int or float :param b: 第二个数。 :type b: int or float :returns: 两个数的和。 :rtype: int or float
add(2, 3) 5 add(2.5, 3.5) 6.0 """ return a + b
```
Markdown格式
markdown
python
"""
这是一个示例 Python 模块文档。
这个模块包含一些简单的函数,用来展示如何编写文档字符串。 """
def greet(name): """ 这个函数用来问候用户。
:param name: 用户的名字。 :type name: str :raises TypeError: 如果 name 不是字符串类型。 :returns: 一个问候字符串。 :rtype: str
greet("Alice") 'Hello, Alice!' """ if not isinstance(name, str): raise TypeError("name 必须是字符串类型") return f"Hello, {name}!"
def add(a, b): """ 这个函数用来计算两个数的和。
:param a: 第一个数。 :type a: int or float :param b: 第二个数。 :type b: int or float :returns: 两个数的和。 :rtype: int or float
add(2, 3) 5 add(2.5, 3.5) 6.0 """ return a + b
- 本文标签: Python
- 本文链接: https://blog.sandy1029.cloud/article/211
- 版权声明: 本文由nisan原创发布,转载请遵循《署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0)》许可协议授权