IDL Codestyle Guide?

ないのか？

NASAの “The IDL Astronomy User’s Library” を参考にしすつ、個人的にこうやって書いたらいいんじゃないか的なのをメモ。

一般的なこと

• 長すぎる行は $ で分割して書く。
• インデントは適切に行なう。

関数・プロシージャ定義

FUNCTION/PRO FUNCTIONNAME END は大文字で書く。引数は小文字で記入する。なるべくキーワード付き引数を使うと後の拡張が楽なんだろう。キーワードは大文字で、同名変数を右側に小文字で書く。なるべく同名にするように心がける。ちなみに IDL は配列を常に裏側で参照渡ししているらしい。気持ちわるー

定義内では必ずインデントする。関数の中身はすぐ次の行から書き始める。一般的には中身の前にコメントを入れる。関数の役割や引数に関してのコメントを関数定義の中に書くか、その前に書くかは流儀が分かれる。中に書くことにする。

関数名は全て大文字で書く。

制御構文

制御構文は必ず大文字で書く。明らかに使わない方が簡潔で美しい場合を除き、 BEGIN END ブロックを使用する。

制御構文の条件には単変数（フラグ）を使用する場合を除き必ず括弧を使用する。

ラベルは必ず大文字で書く。

変数

変数は小文字で書く。ただし、一文字だけの変数、フラグは大文字で書く。

変数は命名規則を元に命名しておくことにする。具体的には Camel 記法、Pascal記法、アンダーバーセパレーションのどれかを使う。自分はアンダーバーセパレーションを利用することにした。

ポインタとグローバル変数に関しては（のみ）ハンガリアン記法 p_ および g_ を使うことにする。配列に関しては a_ を使わない。そもそも組み込みの文字列型があるのと、配列になりそうなものは別途変数名にそう書いてある（***_image とか）なので問題はないだろう。

終わり

コメントはたくさん書いた方がよさげ。