![]() |
|
![]() |
if( sonota_yobi4 == 7 ) { /* 実はこの条件は、請求書の発行かどうかを 調べるものでした。そのことを読み取れる 人はいないでしょう。 */ }
自分で書いたプログラムでも、数日経つと「誰が書いたの?」と思うくらいになるのがふつうです。
そんなプログラムを読んでいくときに、頼りになるのがコメントと変数名です。
今回は、プログラムが分かりやすくなる変数名についてです。
【参考】 Java での変数定義例で比較してみましょう。
(※ ルールはプログラミング言語によって異なります。Java や C言語は大文字と小文字を区別しますがしない言語もあります)
どんな変数 | こっちより | こっち | 説明 |
---|---|---|---|
合計 | int t; や int gk; | int total; | 一時変数でなければ意味が分かり易いように |
見つからない かどうか | boolean notfound; | boolean found; | 「見つからないとき」という判断は if( !found ) の方が混乱しません |
平均値 | double average; | double avg; | 直感的に意味が分かれば、省略した方が読むのも書くのも楽です |
メッセージ | String message; | String msg; | |
フォントの属性 | int fontsize, fontweight; | int fontSize, fontWeight; int font_size, font_weight; |
複数単語の組み合わせは、単語の区切りを大文字にしたり、アンダースコアでつなぐと分かりやすくなります |
送信先アドレス | String destinationaddress; | String destAddr; String dest_addr; | |
幅と高さ | double width, h; | double width, height; double w, h; |
省略するか否かを統一しましょう |
挿入 更新 削除のフラグ |
boolean insert_flag; boolean updateFlg; boolean delflag; |
boolean insflg; boolean updflg; boolean delflg; | 書き方と、できれば文字数も揃えると同種のデータと分かりやすいです |
うるう年判定フラグ |
boolean jfaly; (judgement flag a leap year より命名) |
たとえば boolean isLeapYear; | jfaly では、意味も分からず読めません |