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

新しいプロジェクトに入った時にやること

新しいプロジェクトに入った時に最初にすべきことややっておくことなど Contents1 仕様理解編1.1 ユーザーの行動遷移の理解1.2 キー系のデータの理解1.3 データグルーピング1.4 サンプル …

no image

バッチスクリプトで気をつけたい点

実務でバッチ処理を作る際に気をつけるべきと思ったこと。 基本的にエラーをいかに捉えていかにログに吐くかを最初に考える。まずはエラーありき。失敗するもの、想定した値がこない、あるいは値がないを前提として …

no image

ログの設計指針について

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

no image

画面の制御フローなど

複雑な帳票系アプリではよくあると思うのですが、ある入力値が複数の場所から影響を受けており、制御がなかなか難しいときなどがあります。 例として クリアボタンなどでクリアされる 他のプルダウンなどで影響を …

no image

Eclipseでのソースフォーマットでの自動改行を防ぐ

小ネタ。Eclipseのソースフォーマッタはディフォルトでは一定の字数で改行されしまい、大変見にくくなったりします。 またHTMLなどでは改行してほしいタグが改行されないなど思ったとおりに動いてくれま …