Synopsis 的意思是摘要或者梗概。 在编程中，可以使用 Synopsis 来描述一个函数或者类的简要说明。 Synopsis 应该包含丰富的信息，以便开发人员能够快速理解该函数或类的功能和用法。

在编写 Synopsis 时，应该遵循以下准则：

1. 描述函数或类的功能和用法
2. 列出函数或类的输入和输出参数
3. 包含示例代码片段以说明函数或类的用法
4. 返回的摘要应该是 Markdown 格式的，并且代码片段需按 markdown 格式标明

下面是一个使用 Markdown 格式编写的 Synopsis 的例子：

## 函数名: sum

此函数计算两个数字的和。

### 参数
- a - 数字 - 第一个要相加的数字
- b - 数字 - 第二个要相加的数字

### 返回值
- 数字 - a 和 b 的和

### 示例代码
```python
def sum(a, b):
    return a + b
    
result = sum(2, 3)
print(result)

输出

5

在这个例子中，我们有一个名为 sum 的函数，他接受两个数字作为参数，然后返回这两个数的和。 该函数有些基本的标签，如参数和返回值。代码片段也展示了如何调用该函数以及它的输出结果。