如何多行编写docstring摘要而不触发D205与D400警告?
Markdown格式规范实操指南
标题
使用#标识标题,#的数量对应标题层级:
# 一级标题→ 一级标题## 二级标题→ 二级标题### 三级标题→ 三级标题
以此类推,最多支持六级标题。
列表项
无序列表以-开头,每个列表项单独占一行:
- 第一条列表内容
- 第二条列表内容
- 第三条列表内容
文本强调
用星号*包裹文本实现强调效果:
- 单个星号包裹:
*斜体文本*→ 斜体文本 - 两个星号包裹:
**粗体文本**→ 粗体文本
代码/命令
用反引号`包裹内容,区分普通文本与代码:
- 单行代码/命令:
git status - 多行代码块:用三个反引号开头和结尾,可指定代码语言(可选):
def foo(): print("Hello World")
引用文本
用大于号>标识引用内容:
这是一段引用文本,适合用来标注引用的外部内容或重要提示。
多行引用可以每行都加>,也可以仅在第一行添加,后续内容自动归为引用部分。
链接
格式为[显示文本](目标URL):
示例链接
图片
格式为,替代文本用于图片无法加载时的提示:
内容的提问来源于stack exchange,提问作者Barzi2001
相关产品推荐
相关产品推荐

