skillup

技術ブログ

プログラミング全般

命名規則について その2

投稿日:

リーダブルコードネタ第3段。

前回のエントリーに引き続き、名称の大切さについて

あいまいな名前はNG!

これは実務でもしょっちゅう悩まされてます・・・

リーダブルコードの例としてはfilter~とかだと何をフィルタリングするかわからないから・・というように書かれてました。ここでも具体的な名称の大切さが問われます。

いかにリーダブルコードがすすめる一般的なルールなぞを。

限界値はmaxかminを使う

範囲を指定するときはfirstとlast

a=fisrt , b= lastだったとすると取りうるxの範囲は a<= x <= b

排他的な範囲はbegin,end

a=begin,b=endだとすると取りうるxの範囲はa<=x < b。日時などでよく使われる

bool型では変数名にis,has,shoud,canを付けるとわかりやすい

一般的には否定より肯定のほうが意味がとりやすい

if文でもtrueのほうがfalseよりもわかりやすいですね。否定の否定みたいな書き方だと一瞬どっちだ?となりますので、頭を無駄に使うようなメソッドはやめておいたほうがいいでしょう。

一般的な命名ルールを逸脱するような名称は使わない

getはただのアクセサなのでこれで値を計算したりすることはしないほうがいいでしょう。

-プログラミング全般
-

執筆者:


comment

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

関連記事

no image

画面テストのツールに関して

Unitテストに関してはxUnit一択だと思いますが、UI系のテストツールについて。 IDE(コードを書かずにすむマクロ系)に関して全てChromeで動くことを確認しています。 Contents1 ツ …

no image

VSCodeのPluginなど

Vscodeで使っているPluginなど Contents1 基本2 UML3 git4 PHP コードフォーマット5 golang6 CSV整形 基本 Japanese Language Pack …

no image

コーディングルール 前半まとめ

リーダブルコードを3分の2ぐらいよんだので現時点でのまとめを。 Contents1 いいコードの定義2 具体的な手法2.1 変数の名称2.2 コード自体の見た目2.3 コメント2.4 制御フロー2.5 …

no image

CIことはじめ

業務でJavaのテキスト変換ツールを作成。 プログラムよりもCIツールを使って他人の環境下で正常に稼動させるためにどうするかの調査に時間かかりましたね。 今回やりたかったことは下記の通りです。いわゆる …

no image

ログの設計指針について

今まで10以上近い現場で仕事をしてきましたが、どの現場でも絶対必要になる(かつどこもあまり対策が取られていない)技術としては 検証したい状態の復元がすぐにできる(テストデータ作成) ログの適切な設計 …

アーカイブ