一個主題的剖析
一個主題由幾個部分組成:
標題: 該主題的主題是什麼。首先搜尋現有主題,以確保不重複已存在的內容。Stack Overflow 上其他地方已經涵蓋的主題可能會被刪除。
版本: 主題涵蓋的材料適用的版本。你可以從介紹主題中列出的任何版本中進行選擇,或者全部刪除它們以指示該主題適用於所有版本。有關更多資訊,請參閱版本
簡介(可選): 向讀者和貢獻者解釋所包含示例的組織原則。它位於示例上方,限制為 500 個字元。
示例: 主題的程式碼示例。程式碼應易於閱讀和評論。散文也應該用來解釋理解程式碼所需的概念,但儘量不要過於冗長。
每個主題的一個示例可以是固定的,這意味著它浮動在其他示例之上。這對於簡介部分的擴充套件介紹非常有用。
語法(可選): 可能適合包含手頭主題的語法。此部分始終是程式碼塊,必須是降價列表:
- class.method(required_parameter [, optional])
- function f(int x) = { code defining what the function does }
引數(可選) :在使用語法描述主題時,包含引數詳細資訊也可能是合適的。引數格式化為兩列表:
| `Parameter` | Details |
| --------- | ------- |
| yin | dark |
| yang | light |
備註(可選) :有關該主題的任何其他資訊可能對最終讀者有價值。備註是自由形式的。