取り決め - phptest @ ウィキ

このwikiの運用・編集に関する取り決め

• このwikiは両者が管理者IDを管理し、各自が自身のユーザIDを自己管理する（自分で申請も承認も行なう）
• 互いの名前については、本wikiにおけるユーザ名を用いる。実名は用いない。
  • 「用いてはならない」のではない。出来る限りログ等に残るユーザ名と共通させよう、という程度のことである。
  • 本ページのような形式ばった文書の場合は、敬称は略して構わない。
  • 面倒くさいときはT,M(Tさん, Mくん)で構わない。
• このwikiは、
  • 両者が多くのコンピュータ言語に関する知識と経験を深めるために用いる。
  • 両者が多くのコンピュータ言語に関する情報を手早く入手するために用いる。
  • teddyがmitzを指導するために用いる。
  • 業務上の機密情報は一切取り扱わない。
• このwikiの運用に関し、両者は対等の立場にある。修正・削除の権限は同等にある。
  • ただし、新規作成・追記以外の作業を行なう場合には、事前に「間違い／認識不足の指摘」と「両者の相談を行なう。
  • 新規作成に関しては、当初teddyが主導で行なう。
  • 追記およびデザイン変更に関しては、Mが勉強を兼ねて率先して手を入れていく。
  • 本取り決めに関しても当初は teddy が主導で行なっていくが、いずれ両者協議した上で行なうようになる。
• 各ページの様式については、本ページで取り決める。ただし、随時変更・追加がなされる。
  • 新しい変更にあわせ、出来るだけ早急に if else のページを刷新する。
  • 他のページは時間が許す限り修正していく。古い様式のままでも構わない。

ページ名

• ページ名については、Java における用語をベースに決定する。
  • これは両者がともに Java についての一定程度の知識を有するからである。
  • 一般用語がある場合はそちらを優先して使用する。また、できるだけ併記する。

見出しについて

• 大見出しには言語名を用いる。
  • (ex. Java, PHP, javascript)
• 下位レベルの見出しとして、バージョンや実行環境を示す。
  • (ex. Java1.4, Java5, PHP5, ECMAScript, IE4～など)
• 箇条書きについては現段階では特に取り決めない。読みやすくすること。
  • 「言語規定」なのか「テクニック」なのかが分かるとよい。
  • 伝統的な記法と、新バージョンでの記法やシンタックスシュガーが区別できるようにするのもよい。

ソースコードについて

• ソースコードはそれとわかるように記述すること。
  • 行頭に半角スペース１ヶつければよい。
• 機密情報を含まないこと。
• できるかぎり、動作確認した上で記載すること。
  • 特に、他者が見て解決できないようなコンパイルエラー・シンタックスエラーが出るような状態では記載しないこと！！
    • (これはちまたにあふれていて、teddyが過去散々思い悩まされている)
  • 参照エラーなど、軽微なものは構わない。

/* 以下の場合、a の宣言が無いためエラーとなるが、if 文の書き方の説明としては充分である */
if (a == 0) { System.out.println("zero."); } 

• • 何を参照しているか類推できないようには、けっして書いてはならない。

/* 以下の場合は in のクラスが分からない。 */
/* 従って read が何を行ない何を返すかも分からない。 */
/* 型も分からない(int とは限らない) */
/* 起こりうる例外も分からない */
/* ライブラリが不明なので運用可能な実行環境も不明である */
int data = in.read(); //こうするとひとつづつデータがとれる

• • • コメントでくだくだ追加説明するより、クラス(および必要ならライブラリ/パッケージ名)を明記した方が早い。

/* 標準ライブラリなのでパッケージ名を明記する必要は無い */
/* file の型は類推できる */
InputStreamReader in = new InputStreamReader(new FileInputStream(file));
int data = in.read(); //こうするとひとつづつデータがとれる

• • したがって、エッセンスだけ記述するよりは、動作確認したソースファイルをまるまる貼ってしまった方がいいかもしれない。
    • 半角スペース足すのが面倒だけども。
    • 機密情報まで転記してしまわないよう注意。

引用について

• 各情報については、言語規定または信頼できる情報へのリンクを付与する。
  • むしろそれがメインと言ってもいい。

その他

• 表はメンテナンスが面倒なので、できるだけ使わない。表が掲載されているページへのリンクで済ます。
• 修飾(太字、色)も極力使わない。