お作法
オープンソースなプログラムを書くときは勿論必須なんだろうけど、知っといたらよりソースを読みやすいだろうなと思って、Androidのコーディング規約を勉強中。
textdrop.net - このウェブサイトは販売用です! - リソースおよび情報
これまでは自分向けのものばかり作ってるし、分かりにくいポイントだけ「//ここでこんな処理をする」とかコメントつけてるだけだったんだけど、ある程度共通した書き方を知っておけば、整理しやすいのかなと思った。
多少労力がかかるかも知れないけど、こういうスタンダードをちゃんと知っておくのは将来的に大事だと思う。
まず、一番基本となるJavaコーディング規約について。
大元はSunのCode Conventions for the Java Programming Languageなんだけど、いかんせん古いので、比較的最近にできたJavaコーディング規約2004年版を参考にしました。
- http://www.objectclub.jp/community/codingstandard/JavaCodingStandard2004.pdf
- 電通版。一つ一つにサンプルがついてて分かりやすいけど量が多い。
- http://www.smg.co.jp/seminar/techsquare/SMG_JavaCodingStandard.pdf
- エスエムジー株式会社の製作。上のものと多少違う点がある。ループ変数はi,j,kでやっちゃいかんとか。
賛否両論あるのだろうけど*1、概して合理的なものなんだと思う。まずはこれ読んでから。
Androidコーディング規約では、これに加えていくつかルールを追加してる。多少2004年版と被るところもあったり。
少なくとも、フィールド名とかエラーレベルの項は、読んで知っておいて損はないと思う。