Ognacの雑感

木漏れ日々

目次

Blog 利用状況

書庫

ギャラリ

読みやすいメソッド名をつけませう

最低限のルールですが、読みやすそうで読みにくい名前があったりします。
例1:
 if (dataCheck)
    処理A();
 else
    処理B();

これではdataCheckでエラーがあった時の処理は A/Bのどちらか判別付きません。

そのように指摘すると、
  dataCheckメソッドのソースのHeaderに
     // 戻り値:  true: 正常  :  false: 異常データ存在
  と明記されているので判別付きます。
と愚痴られた上で、ソースは
例2:
 if (dataCheck)  // true: 正常  :  false: 異常データ存在
    処理A();
 else
    処理B();
となっていた。

これだとソース本体とコメントとメソッド仕様の3箇所を読まないと意味が掴かめません。
諸兄達が論じているように、判定ルーチンは is_XXX類の命名にすればいいと思っています。

例3
 if (is_dataCheck_OK)
    処理A();
 else
    処理B();

 if (is_dataNoError)
    処理A();
 else
    処理B();
のように 戻り値がbool型の時は is_xxx が読みやすいです。

日本語命名の時はどうなるんだろう
 if (データ正常)       ?
 if (データ)           ?
 if (エラー無)         ?
 if (isデータチェック) ?  :  ローマ字混合は引っかかるなぁ

動詞+名詞の規則ができないので命名し難いでずか  if (データ正常) が解りやすいかな

可読性の意識は個人差があるので、記述標準で規定して強制するしかないのかなぁ。

 

 

 


 

投稿日時 : 2007年8月30日 12:07

Feedback

# re: 読みやすいメソッド名をつけませう 2007/08/30 12:19 かずくん

bool型を返すメソッドとして、
データ内容検証する場合、Validate~
値の存在を確認する場合、Contains~
もよく使います。

# re: 読みやすいメソッド名をつけませう 2007/08/30 13:13 Mr.T

Mr.Tです、こんにちは?

if (**データの値は問題ない?) then
else
end if

#いや、ごめんなさい、やっぱりそういう名前はつけないや...

# re: 読みやすいメソッド名をつけませう 2007/08/30 21:23 中博俊

Isは処理しないことを期待するので不適切でしょう。
処理結果ならばわかりますが。

# re: 読みやすいメソッド名をつけませう 2007/08/30 23:41 Ognac

そうですね is_xxxではニュアンスとしてそぐわないですね
といって エラーがあるか の意味で if( has_Error) とするのも......いいのかな?

# re: 読みやすいメソッド名をつけませう 2007/09/01 11:03 さかもと

さかもと(某busai...ところで)と申します。
「超図解 VB.NET ルールブック」という本を手元に基本を勉強してます。
最近はマシになってきましたが昔の自分のソースを読むと・・・・。

タイトル
名前
Url
コメント