編集のガイドライン

Last-modified: 2007-03-24 (土) 00:54:39

ルールじみた物は作りたくないが、参考までに。

ソースコードの記述について

ソースコードは、webサイトに記載する場合は整形済みテキストとして記述するのが一般的である。
このwikiでは半角スペースで始まる行が整形済みテキストとなる。

int main()
{
  // 一例。
  int result;
  if(true)
  {
    result = 0;
  }
  return result;
}

コメントの後の空行にも半角スペースが挟んであることに注意しよう。これを怠ると上半分と下半分で2つのボックスに分かたれてしまう。
なお、半角スペースと全角スペースを混同しないように注意しよう。

助言

可能であれば行頭には適切な量のインデントを挟もう。ただし、これについては個人のプログラミングスタイルに依存するものであるし、そもそも本職のプログラマーでない人には馴染みのない概念かもしれない。しかし、インデントを取ることについて理解があるのにwikiに不慣れなためにインデントを取らないというのはもったいないだろう。上の例では、 インデントのレベルが上がるごとに2つのスペースを追加している。
また、整形済みテキストの中でタブを使うのは好ましくないとされる。インデントは極力スペースで取った方がよい。