在 GitHub 上，Markdown 是一种非常流行的轻量级标记语言，它允许你以易于阅读和格式化的方式创建文档和代码注释。掌握 Markdown 可以让你更高效地在 GitHub 上工作，无论是编写项目文档、提交代码更改还是注释他人的代码。以下是使用 Markdown 在 GitHub 上创建实用文档与代码注释的攻略。
1. 基础语法
1.1 标题
使用 # 来创建标题，其中 # 的数量决定了标题的层级。
# 一级标题
## 二级标题
### 三级标题
1.2 段落
直接输入文本即可创建段落。
这是一个段落。
1.3 强调
使用星号或下划线来创建斜体或粗体。
*斜体*
**粗体**
1.4 列表
使用 -、* 或 + 来创建无序列表，使用数字和句点来创建有序列表。
- 列表项1
- 列表项2
- 子列表项1
- 子列表项2
1. 有序列表项1
2. 有序列表项2
1.5 链接
使用方括号和圆括号来创建链接。
[链接文本](链接地址)
1.6 图片
使用感叹号、方括号和圆括号来插入图片。
1.7 代码
使用反引号来创建单行代码块或多行代码块。
`单行代码`
\`\`\`
多行代码
\`\`\`
2. 实用文档
2.1 项目概述
在项目 README 文件中使用 Markdown 创建项目概述，包括项目名称、描述、安装指南、使用方法和贡献指南。
2.2 用户文档
编写用户文档时，可以使用 Markdown 来组织内容，例如使用标题、列表、表格和图片等元素来提高可读性。
2.3 开发者文档
开发者文档通常包含 API 文档、代码示例和开发指南。使用 Markdown 可以清晰地展示代码片段和注释。
3. 代码注释
3.1 单行注释
在代码中添加单行注释，使用反引号。
// 这是一个单行注释
3.2 多行注释
在代码中添加多行注释，使用三个反引号。
/*
这是一个多行注释
*/
3.3 文档字符串
在 Python 中，使用三个引号来创建文档字符串，用于描述函数、类或模块。
def my_function():
"""
这是一个函数的文档字符串
"""
pass
4. 高级技巧
4.1 表格
使用竖线、横线、空格和文本来创建表格。
| 表头1 | 表头2 | 表头3 |
| --- | --- | --- |
| 内容1 | 内容2 | 内容3 |
4.2 引用
使用大于号来创建引用。
> 这是一个引用
4.3 代码高亮
使用 language: 属性来指定代码语言，并使用三个反引号来创建代码块。
```python
print("Hello, World!")
”`
5. 总结
Markdown 是一种简单易用的标记语言，可以帮助你在 GitHub 上创建美观、实用的文档和代码注释。通过掌握 Markdown 的基础语法和高级技巧，你可以更高效地协作和分享你的代码项目。