現時点でのコーディングルールです。あくまでも個人的なものなのでお許しを・・・🙇
- 変数のプレフィックス: 変数の先頭3文字は文字列型を示すプレフィックスを付ける(例:
str
,lng
,dbl
)。賛否あるけど、型が直感的にわかるのは大きなメリットだと思う🤔 - ハンガリアン記法: 変数名はハンガリアン記法で作成する。不要という人も多いけど、型がわからないと何かと直感的にわかりづらいので・・・💦
- メソッド名: サブルーチン、関数、またはオブジェクトのメソッド名はキャメルケースを利用する。(例:calculateTotalAmount , getUserName , printReportDetails 等)単純に入力しやすいんですよ😓
- メソッド名のプレフィックス: プロシージャの場合は先頭3文字を「prc」、関数の場合は「fnc」で始める。理由:日本語の方が直感的に、圧倒的にわかりやすい・・・けど、先頭を日本語にするとコードインテリジェンスがめんどくさくなるため。何はともあれ例えば「prc」で入力すれば自分が作ったルーチンがズラッと出てくる。これをやらないと「あれ?あの処理、何ていう名前だったっけ?🐔ピヨピヨ」となるため。
- コメント: メソッド名の上部にコメントで機能概要と処理内容の説明を記述する。できるだけシンプルに、余計な飾り文字は入れない。その方が汎用的に使えるため。上に入れるとか下に入れるとかいろいろあるけど、正直こだわりはない・・・なので一応、上にしておく😓
- 変数の型: 変数の型が特定できる場合はオブジェクト型やバリアント型を使わず、固有の型を使用する。(これは当たり前ですよね)というか、これやってないコードのメンテナンスとか気が狂いそうになるヨ。全部バリアントとか、そもそも変数宣言してないとか、「書いたやつ、出てこいや~!」と言いたくなりません?😭
- コードの視認性:
If
やLoop
内の処理が長くなる場合には、ラベルを作成してスキップしたりして、「簡潔に」する。尋常じゃない長~いif節とか、正気の沙汰とは思えない長大なloopとか、カンベンして~!(多々経験あり)😢 あ、でもラベルの乱用は厳禁(本当に必要最低限にしないと、もうグチャグチャというか、ループ抜ける・エラートラップ時くらいにしておかないと、発狂必至になりますよね🌀 - 変数宣言の位置: 変数はプロシージャ概要の下にまとめて記述。コード内の中途半端な位置で宣言しない。これは賛否あるけど、個人的にはこっちの方が好き💓
- 変数宣言のコメント: 変数宣言の後ろに、用途のコメントを記述する。(ええ~😯)でも、後でありがたみがわかるんですよね。作る時は本当に、めんどくさいけど💦 略語とか使った時は数ヶ月もすれば「これ、なんでこういう名前にしたんだっけ🐓」となりますので。いや、最近はもう数日でそうなりますよ。いやいや、数時間でもう、最近は・・・ブツブツ
- 日本語メソッド名: メソッド名は日本語にする。これも賛否あるけど、今までカッコつけて英語で書いてたこともあったけど、やっぱり日本語の方が圧倒的に、直感的にわかりやすい。(他の人がメンテナンスに入った時もわかりやすいし)「素人っぽい」とか言う人もいたけど、個人的にはわかりやすさ重視かな。
- 何かあったら追記していきます😊