0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 1 year has passed since last update.

変数・関数の命名ケーススタディ - My Best Practice for the name of Functions or Variables

Posted at

Funciton - 関数

timeComparison
時間に関する何かを比較するんだろうなとはわかる。でも結局何をするものなのかわからない。
例えば、時間が過去かどうか判定するなら、validateObjectIsInPast
過去かどうかだけじゃなくて未来も判定したいよ、って人。それは関数を分けるか、それは何のための関数なのか考えるべき。きっと何のために時間を過去か未来かを判定しているのかってのがあるはずで、その場合はそれに即した命名をするべき。
(Objectはなにか特定の)

NumberingObjectReference
ObjectのReference(数字)を生成するための関数。なんかNumberingって一般的じゃない気がするのでGenerateObjectReferenceでいい

Variable - 変数

pastObject
=> IsPastObject booleanはわかりやすく
isPermission
=> hasPermission isだと権限かどうか。hasだと権限を持ってるかどうか

isEnable
=> isEnabled 過去分詞

atts
=> attendees 略しすぎてなんの変数かわからん

var emails string
var email []string
型と変数名は一致させよう。配列=>複数のものが入る=>変数名も複数形

両方

completeObject v.s. completedObject
completeObjectはObjectをComplete処理する関数に使う方が良い。
completedObjectはcompleteされたObjectを格納する変数に使う方が良い

あとがき

Codingしていると、ついつい自分はわかるから、と適当な名前を付けてしまうことがありますが、
チームで仕事している場合は他の人が一目でわかるようになっているように心がけるようにしましょう。
また、タイミングを見つけたり事例を発見したらこの記事を更新したいと思います。

Reference - 参考資料

https://qiita.com/Ted-HM/items/7dde25dcffae4cdc7923
https://qiita.com/KeithYokoma/items/2193cf79ba76563e3db6
https://qiita.com/usatie/items/b41adf8114188406d2b8

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?