Eosの開発におけるTIPS

提供: Eospedia
2016年5月17日 (火) 10:56時点におけるTacyas (トーク | 投稿記録)による版

(差分) ←前の版 | 最新版 (差分) | 次の版→ (差分)
移動: 案内検索

変数名の付け方

 Eosの中での変数名の付け方の一般的なルールを書いておきます。ひどく縛っている訳ではありませんが、ある程度したがって頂けると、デバッグが楽になります。

一般的な命名規則

 最初の単語は小文字、それ以降の単語は大文字で始め、前置詞は小文字で始めます。省略形は全て大文字で書いています。 また、メソッドが最後になる場合が多くあります。ときどき、省略した単語が使われることがあります。 例えば、

mrcImage
ctfInfo
lmrcImageCorrelation
lmrcImageEuclidDistanceCalc


ただし、defineなどで定義された変数や定数は全て大文字で定義しています。

予約語として

DEBUG
DEBUGXXXXXX

は、デバッグ用の特別な定数を表現しています。


関数名

 関数名は、各クラスの名前で始めるか、もしくは、その名前にlをつけたもので始めています。 例えば、mrcImageのクラスでは、

mrcImageYYYYYY
lmrcImageXXXXX

と名前がついたものが多くあります。前者は、mrcImageの構造体(クラス)に対して、直接的に操作するようなメソッド、後者は、画像処理等の関数名を表現しています。