Documentation
トピックのスコープ
サーチ…
前書き
トピックは可能な限り単純にする必要がありますが、単純ではありません。これは、Stack Overflow Documentationで見られるいくつかの構成原理を示唆しています。
言語機能トピック
自然な部分は、言語機能ごとに1つのトピックを作成することです。たとえば、 Pythonには次のようなものがあります。
- クラス
- 関数
- 発電機
- デコレータ
- 。 。 。
欠点は、機能が非常に複雑になることがあり、単一のページに意味をなさないよりも多くの例を思いつくのは簡単です。 クラスには16の例があります。それらのうちのいくつかは、おそらく継承、プロパティ、メソッドなどの他の機能トピックに移動することができます。
グラブバッグトピック
いくつかのトピックは、 C#6.0の機能や一般的な落とし穴のようなテーマの下でゆるやかに関連付けられた例です。コンテンツの追加を止める自然な場所がないため、トピックごとの例が限られていたため、全体的にはこのスタイルのトピックは推奨されていません。
例を別のトピック(おそらく言語機能用 )に移す方が良いでしょう。私はこれをしていないと思っていますが、これらのトピックは、主に他のトピックや例へのリンクからなる例を含むメタトピックに変換することができます:
Perlのヒントとテクニック
- 正規表現でXMLを解析しないでください! XML解析モジュールを使用します 。
- ブロック全体をコメント化する必要がある場合は、 PODコメントブロックを使用してください。
- 。 。 。
Modified text is an extract of the original Stack Overflow Documentation
ライセンスを受けた CC BY-SA 3.0
所属していない Stack Overflow