Documentation
トピック
サーチ…
前書き
トピックの作成
トピックを作成するには、次の手順を実行します。
- タグのダッシュボードで
Create New Topic
をクリックしCreate New Topic
。 - トピックに名前を付けます。
- 「例」セクションで詳細な例を示します。
- さらに共有する場合は、「構文」、「パラメータ」、および「備考」セクションを使用します。
あなたはトピックを作成しました!話題は誰もが利用できるようになり、誰もが編集することができます。
スタックオーバーフローのドキュメントでは、例はショーのスターです!
トピックの解剖学
トピックはいくつかのセクションで構成されています。
タイトル:トピックの主題は何ですか。既に存在するコンテンツを繰り返していないことを確認するには、まず既存のトピックを検索します。 Stack Overflowの他の部分ですでにカバーされているトピックは削除される可能性があります。
バージョン:トピックが対象とする資料が適用されるバージョン。導入のトピックに記載されているバージョンのいずれかを選択するか、それらをすべて削除して、そのトピックがすべてのバージョンに適用されることを示すことができます。詳細は、「 バージョン 」を参照してください。
はじめに(オプション):読者と投稿者の両方に含まれる例の構成原理を説明します。例の上にあり、500文字に制限されています。
例:トピックのコード例コードは読みやすく、よくコメントされるべきです。 Proseは、コードを理解するために必要な概念を説明するためにも使われるべきですが、あまり冗長ではないようにしてください。
トピックごとに1つの例を「固定」することができます。つまり、他の例より上に浮動します。これは、紹介セクションでは長すぎる拡張イントロの場合に便利です。
構文(オプション):トピックの構文を含むことは適切かもしれません。このセクションは常にコードブロックであり、マークダウンリストでなければなりません:
- class.method(required_parameter [, optional])
- function f(int x) = { code defining what the function does }
パラメータ(オプション) :構文のようにトピックを記述する場合、パラメータの詳細を含めることも適切です。パラメータは2列のテーブルとしてフォーマットされます。
| Parameter | Details |
| --------- | ------- |
| yin | dark |
| yang | light |
備考(オプション) :エンド・リーダーにとって価値のあるトピックに関する追加情報。備考はフリーフォームです。
入門トピック
新しいドキュメンテーションタグが作成されると、StackOverflowは最初の実際のトピックのプレースホルダーとして機能する導入トピックを自動的に生成します。
入門トピックには、プレースホルダーのテキストと、新しいドキュメンテーションタグを拡張するための貢献者を正しい方向に指すポインターが含まれています。
入門トピックは削除できませんのでご注意ください。 この質問を見る