Python文档字符串中note块添加无序列表的可行性及实现方法

AI 小北

2026-8-21

Markdown 格式使用规范

标题：使用数字符号（#）定义，#的数量对应标题层级，1个#为一级标题，2个为二级标题，以此类推。示例：
```
# 一级标题
## 二级标题
### 三级标题
```
列表项：以短横线（-）作为开头，支持嵌套层级。示例：
```
- 一级列表项1
- 一级列表项2
  - 二级嵌套列表项
```
文本强调：用星号（*）包裹内容，单星号实现斜体效果，双星号实现粗体效果。示例：
```
*斜体强调文本*
**粗体强调文本**
```
代码/命令：单行内容用单个反引号（`）包裹，多行代码用三个反引号（```）包裹，还可指定代码所属语言。示例：
```
单行命令：`git status`
多行代码：
```javascript
function add(a, b) {
    return a + b;
}
```
引用文本：使用大于号（>）标记，多级引用可叠加多个>。示例：
```
> 基础引用内容
>> 嵌套引用内容
```
链接：采用[链接显示文本](目标URL)的格式。示例：
```
[开源项目主页](https://github.com/example)
```
图片：采用[图片替代文本](图片URL)的格式，替代文本会在图片无法加载时显示。示例：
```
[风景示意图](https://example.com/scenery.jpg)
```