一个主题的剖析

一个主题由几个部分组成:

标题: 该主题的主题是什么。首先搜索现有主题,以确保不重复已存在的内容。Stack Overflow 上其他地方已经涵盖的主题可能会被删除。

版本: 主题涵盖的材料适用的版本。你可以从介绍主题中列出的任何版本中进行选择,或者全部删除它们以指示该主题适用于所有版本。有关更多信息,请参阅版本

简介(可选): 向读者和贡献者解释所包含示例的组织原则。它位于示例上方,限制为 500 个字符。

示例: 主题的代码示例。代码应易于阅读和评论。散文也应该用来解释理解代码所需的概念,但尽量不要过于冗长。

每个主题的一个示例可以是固定的,这意味着它浮动在其他示例之上。这对于简介部分的扩展介绍非常有用。

语法(可选): 可能适合包含手头主题的语法。此部分始终是代码块,必须是降价列表:

- class.method(required_parameter [, optional])
- function f(int x) = { code defining what the function does }

参数(可选) :在使用语法描述主题时,包含参数详细信息也可能是合适的。参数格式化为两列表:

| `Parameter` | Details |  
| --------- | ------- | 
|       yin |    dark | 
|      yang |   light |

备注(可选) :有关该主题的任何其他信息可能对最终读者有价值。备注是自由形式的。