R Language
メタ：ドキュメンテーションのガイドライン

備考

良い例を作る

Q＆Aの良い例を作成するための指針のほとんどは、ドキュメントに引き継がれています。

• 最小限にして、ポイントに到達してください。合併症や偏見は逆効果です。

• 作業コードとそれを説明する散文の両方を含める。どちらも単独では十分ではありません。

• データの外部ソースに依存しないでください。可能であれば、データを生成するか、データセットライブラリを使用します。

  library(help = "datasets")
  

ドキュメントのコンテキストには、いくつかの追加の考慮事項があります。

• 関連する場合はいつでも?data.frameような組み込みのドキュメントを参照してください。 SO Docsは、組み込みの文書を置き換える試みではありません。新しいRユーザーには、組み込みのドキュメントが存在することと、それらのドキュメントを見つける方法を知っておくことが重要です。

• 複数の例に適用されるコンテンツを[備考]セクションに移動します。

スタイル

プロンプト

コードをコピー・ペースト可能にする場合は、改行の始めにR> 、 > 、 +などのプロンプトを削除します。ドキュメント作成者の中には、簡単にコピー貼りをしたくないものもあります。これは大丈夫です。

コンソール出力

コンソールの出力はコードとはっきりと区別する必要があります。一般的なアプローチは次のとおりです。

• 入力時にプロンプ​​トを表示します（コンソールの使用時に表示されます）。
• #または##各行を開始して、すべての出力をコメントアウトします。
• 現状のまま印刷し、先行[1]を信頼して、出力を入力から目立たせます。
• コードとコンソール出力の間に空白行を追加します。

割り当て

=と<-は、Rオブジェクトの割り当てには問題ありません。 x<-1 （ x <- 1とx < -1間にあいまい）など、解析が困難なコードを書くのを避けるために、空白を適切に使用してください。

コードコメント

コード自体の目的と機能について説明してください。この説明が散文かコードコメントであるべきかどうかについては、固くて速い規則はありません。散文は読みやすくなり、説明が長くなりますが、コードコメントは簡単にコピーして貼り付けることができます。両方のオプションを念頭に置いてください。

セクション

多くの例はセクションを必要としないくらい短いですが、使用する場合はH1から始めます。