プログラミング初心者は変数名やメソッド名を略さない方がいいよ、という話 - give IT a try

今回のエントリでは先日、僕が勤めているソニックガーデンで話題になったプログラミング関連の小ネタを書きます。 それは何かというと、「プログラミング初心者は変数名やメソッド名を略さない方がいい」という話です。 長い変数名やメソッド名はつい略したくなります。 実際、僕も長い名前を略すときはよくあります。 ですが、略称を使うのは長年の経験から「この略称は一般的だから誤解を招くことはきっと少ないだろう」とか「前後の文脈から、変数の中身は誰が見ても明らかだろう」という想像が付いた場合だけです。 一方、プログラミング初心者の人は経験が浅いため、「一般的かどうか」とか、「誤解が発生しないかどうか」といった判断ができません。 そのため、他の人が見たときに「え、何この変数名？」と思ってしまうような略称を付けてしまう恐れがあります。 たとえば、先日のコードレビューで、初心者の人がrev_noという名前の変数を定

[chiroruxx]

わかる。ブコメの人と正反対だけど、可読性を上げるために、名前を省略しないで書くかな。省略しないで変数名が40字とか行く場合は、スコープの切り方を疑いたい。

[Keisuke69]

個人的には初心者とか関係なく略さない方がいいと思ってる派。一般的の範囲ってベテランだろうが人によるので

[kiyokura]

完全に同意。さらに言うと英語での名前付け悩むくらいなら一旦は漢字ひらがな交じりの日本語で変数やメソッド名書いてしまって、必要に応じてIDEやUnitTestの力借りながらリファクタリングすればよいと思ってる派。

[otihateten3510]

ベテランですが省略しません。省略見るとイラッとします。よろしくお願いいたします。

[el-condor]

基本的には略さない派。ただ実装に使うプログラミング言語の慣習によるところも大きいかなあ。例えばRustのiteratorならiterにするのが普通とか。

[mr_ozin]

messageをmsgって略されるとマイケル・シェンカー・グループが頭にちらついてしまうので略さず書いてほしい

[letsspeak]

略さないで長いタイプ数になるのは大抵設計ミスってるか名前を考える時間が短すぎる

[mushus]

同意、ついでに言うとコードを説明的に書いてコメントはWhyしか書かない派 (別のチームとのインターフェースになるものについてはドキュメントを書く)

[kkobayashi]

タイピング量を減らしたいから、というより1行が長くなって見づらいから、のほうが理由としては大きいかな。略さない方がよいのは同意

[stabucky]

“No.”は”.”を付けないとナンバーとは読まない。

[u1tnk]

よく指摘する内容をブログにして自分で使う…この方針を見習っていかねば

[raimon49]

省略しない方が良い点は同意で、その上で自分用のコードだったらrevison_numberはrev_numくらいに縮めちゃうかな。

[ghostbass]

そのスコープで理解するために十分な長さで明確な名前にする。短すぎるより長い方がよい。名前を省略することで得られるメリットより読みづらくなる事のインパクトが大きい。

[t-murachi]

スコープが限られている変数についてその役割を理解しづらいのだとすれば、それはもはや名前の問題ではない。「逆順の番号」と書かれていても、そのスコープの役割自体を知っていなければ、結局意味は分からない。

[jusys2-13bpower]

新人にみせたい

[sinsinchang]

省略したがる人って指摘しても直さないんだよなぁ。。。

[Harnoncourt]

初心者ほど略したがる傾向があると思います。

[xlc]

そもそもreverse_numberの意味が分からない。なのでどうせソースを見る。私は変数名は短い方がいいと思ってる。長いと無闇にインデントが発生して見にくくなる。

[su_zu_ki_1010]

業界用語とか社内用語は略すると却ってわかりにくいので出来れば日本語変数にしたいところ。でもhtml側で対応してないんだよな～（thymeleafはエラーになる）。

[rryu]

今自分が思い付いただけの略語は大体誰にも分からないので、短くしたいだけなら1文字とかでも大差はないという。

[mas-higa]

省略するのは、プログラムの構造を把握しやすくするためです。1行がやたら長いと何かがスクロールの先に隠れていたり、全画面に広げると他の情報が見えなくなったり、それを避けるために不要な折り返しを…

[masayoshinym]

プログラミング初心者はリーダブルコードを読むといいよ、という話に繋がる。

[tmtms]

自分はどっちかというと書きづらいからというより読みづらいからだな / “長い名前を略したい一番の動機は、「タイピング量を減らしたいから」だと思います”

[crexist]

間違い。初心者じゃなくてもなるべく略さない方がいい。API とか略語が一般的になってるものであればいいが。

[vuy]

さすがに kbn_flg みたいな母音省略するおじさんは駆逐された感があるけどね。

[onesplat]

略しまくる(自称)上級者のほうが余程タチが悪いんだよね

[odakaho]

だいたい、変数やメソッドのネーミングセンスないやつはロジック自体もクソやね。

[shikiarai]

どっちかというと隙あらばグローバル変数にしてしまうのをとっちめて欲しい。保守性が最悪

[mohno]

名前を短くするのは画面が狭い、メモリーがきつい時代の名残りかな。C言語とかライブラリ関数の名前が略称だからね。とはいえ、私も“文書”中では略称を使うし、ローカル変数はいいだろ、という気が。

[peketamin]

すごく長くなってしまう時は、モジュール名をコンテキストとして少し短くできないか検討したい

[poponponpon]

IDEで補完しながら書くのが主になったしコード容量の制限も無いし略すメリットが無いよね

[baronhorse]

名前はいまだに悩むわ

[Amigomr]

省略せずに、変数名が長くなるとすればスコープが広すぎるかも。同様にメソッド名が長くなるとすれば1つのメソッドでいろいろやりすぎかも（SOLIDの「S」）。と思うが、まあ名前付けは難しいよねと。