« ぽりぽり | トップページ | 喰い合わせ »

2009/04/24

自分のコード規約 -1-

誕生日、祝ってくれた皆様、ありがとう御座いました。
僕は元気です。すこぶる。

アマガミをとある筋より、プレゼントしてもらいました。
案外高価だったので申し訳ない気持ち、とか微塵も見えてなかったですよね?
恐縮です。使い方間違ってるか。

髪の毛が全体的にパーマのふわくしゅ系セミロング、
サバサバ系幼馴染、のたなまっつぁんを攻略。
中の人は、佐藤利奈さんで、
みなみけの長女・春香の中の人です。
あとレールガンの中の人。
明日のよいちの長女の中の人。長女多すぎ。


アマガミされたシーンは出会いのみ。
それ以降アマガミされないとか、どんだけ詐欺なの。
あ、タイトルと全然違う話をしているので、今日はここまで。


以下、備忘録。












◇命名規則

◆共通事項



1.英単語の省略禁止。

省略可能リストの英単語以外省略禁止。



2.英単語の区切り。

変数名・関数名の英単語の区切りごとに、

先頭のアルファベットを大文字にする。



3.役割の明示。

名前を見ただけで役割を判断できるよう命名する。



4.名前の競合。

競合が発生するおそれのあるような単純な名前をつけない。

Eclipse等クラスを判断して変数を検索できるIDEが共有できる場合は、

この限りでない。



5.ローマ字の禁止。

ローマ字で命名しない。ただし、適当な英訳がない場合、

ローマ字が英単語になっている場合をのぞく。





◆型名



1.基本型

short、float等を使わずライブラリが用意した、s16、f32等を使用する。

ただし、typedef等で変更できない、Java・C#はこの限りでない。



2.構造体・クラス(未完成)

プリフィックスとして、構造体名にはstc、クラス名にはCをつける。





◆変数名



1.変数名の基本形

基本形は、「[スコープ]-[ポインタ]-変数名」とする。



2.スコープ識別

グローバル変数をg、広域変数をs、メンバ変数をm、ローカル変数を無名、もしくはl_とする。



3.ローカル変数

引数と名前が競合しそうな場合等、スコープをつけ、

小文字から開始し、区切りごとに大文字にする。

ポインタの場合、ポインタを表すpの後を大文字とする。



4.ポインタ

型名の前にpをつける。ポインタのポインタの場合はppとなる。




5.配列

配列の場合、スコープの後にaをつけることを許可する。



6.ループカウンタ

do、while、for文ようにループカウンタを使用することを許可する。

i,j,k,l,m,nまで。





◆関数名



1.基本形

基本形は、「[スコープ]-[動詞]-[目的語]」とする。



2.スコープ識別

グローバル関数をg、広域関数をs、メンバ変数をm、もしくは無名とする。



3.大文字開始

オーバーライド、強調したい関数の場合先頭を大文字にすることを許可する。





◆定数名

全て大文字にする。単語の区切りごとにアンダーバーをつける。

対象は以下の通り。

・define

・const

・enum

・final static(finalのみの場合は対象にならない)





◆コメント

1.フォーマット

フォーマットは、javadoc形式を使用する。

また、以下のものは必須とする。

・@param(引数がある場合のみ引数の説明)

・@return(返却値の説明)





初版-2009.04.24

記入者-初樹(h.atsuki)

|

« ぽりぽり | トップページ | 喰い合わせ »

コメント

誕生日おめぃ。

投稿: 楓 | 2009/04/24 20:43

お、祝いコメ、サンクス。

投稿: 初樹 | 2009/04/27 10:18

誕生日おめぃ。

>コード規約
確かにこういうのは読み返せるように
どっかにメモった方がいいよね、と思った

投稿: Phol | 2009/04/27 12:12

>Pholさん
あ、誕生日祝いコメありがとうございます。

コード規約は自分が秘密裏にやってるプロジェクト
のみに適用されます。
仕事とは無関係ですわ。
あと自分のwikiのほうに最新版を移しました。

コード規約の重要性はいまだ見えてきません。

投稿: 初樹 | 2009/04/27 16:06

コメントを書く



(ウェブ上には掲載しません)




トラックバック

この記事のトラックバックURL:
http://app.f.cocolog-nifty.com/t/trackback/173402/29265167

この記事へのトラックバック一覧です: 自分のコード規約 -1-:

« ぽりぽり | トップページ | 喰い合わせ »