読者です 読者をやめる 読者になる 読者になる

いつ俺〜いつから俺ができないと錯覚していた?〜

学生ブロガー。大学院でプログラミングを専攻している。日本のプログラミング教育に疑念を抱く。

あなたは変数の名付け親です。子供の名前だと思って大事に付けてね

プログラミング

f:id:shun_prog0929:20151220110302j:plain


子供ってホントかわいいですよね。

とてつもなく癒されます。

どうも、shunです。


さて、今日は名前のつけ方について話しますよ!!

皆さんは、変数名とか、クラス名とか、idとかちゃんと意識して名前付けてますか?

これ実際すごく大切なんですよ?

前回コメントを付けることの大切さを挙げましたよね?

読んだことない人はこちらを要チェック!

大事なことなので、もう一度いいますよ。

こちらを要チェック!


www.ituore.com


ただ、できることなら細かいところまでコメントをつけたくない。

誰もがそう思います。

だって面倒ですもんね。

じゃあどうするか。

名前をちゃんと考えて付けるんですね

では参りましょう。

名付け親としてのセンスはどうだ!?選手権!!


名前のつけ方

さて、名前のつけ方といってもどういうこと?と思うかもしれませんから、例を挙げながら説明していきますね。

まず、このようなコードがあったとしましょう。

class A {
  int a;
  double b;
  double c;
}


これは僕の大好きなJavaのコードなんですけど、これ何を表してるのかわかりますかね?

全然わかりませんよね(笑)

これに対してこういうコメントつけたとしましょう。

/* 人間クラスです */
class A {
  int a; // 年齢
  double b; // 身長
  double c; // 体重
}


これなんか正直アホじゃないですか?

こんな意味わからない名前をつけてコメントで補うなんてちょっと効率悪すぎますよね。

と、いうわけでこのように名前を変更してみます!

class Human {
  int age;
  double height;
  double weight;
}


これなら、コメントがなくてもわかりやすいですよね!

要はこういう話なんですよ。

今回は単純な例で話してみましたけど、これが大きなプログラムになればなるほど、名前のつけ方が大事になってきます。

この名前のつけ方、テキトーにしちゃってる人、結構いますからね!

重要なのは、誰が見ても何をやっているのかわかること!

前回の話と被りますが、1ヶ月後の自分が見てもわかるためには、誰が見てもわかるように書くべきなんですよ。

うん。

ブログではどうする?

僕のブログを読んでくれてる人には同じブロガーの方が多いので、ブログに関するところも書いておきましょう。

これも実際、名前がすごく大事ですからね。

ただ、HTMLの場合には少し話が変わってきます。

次のようなHTMLがあったとしましょう。

<div id="global-menu">
  <ul id="global-menu-list">
    <li class="global-menu-element"><a href="#" id="home">Home</a></li>
    <li class="global-menu-element"><a href="#" id="profile">Profile</a></li>
    <li class="global-menu-element"><a href="#"id=twitter>Twitter</a></li>
  </ul>
</div>


すべての要素がどんな役割なのかわかるようにidやクラス名をつけてみました。

悪くはない!

悪くはないんだけど。。。

うーん。

ごちゃごちゃしてますね。

そう、HTMLに関してはこういうつけ方はあまりよくない。

それはなぜか。

タグ名である程度役割がわかるからです。

ulは順序のないリストを表していることがわかってるし、liがその要素であることもわかってますからそのようなidやクラス名はつけなくてよい!

<div id="global-menu">
  <ul>
    <li><a href="#" id="home">Home</a></li>
    <li><a href="#" id="profile">Profile</a></li>
    <li><a href="#"id=twitter>Twitter</a></li>
  </ul>
</div>


これでおっけー!

すっきりしていても内容はわかります。

これでわかりにくいようならそれこそコメントをつけておくべき。

特にHTMLはCSSと組み合わせるので、無駄なクラス名やidは付けすぎないが吉。

というわけです。

まとめ

今回は名前の付け方の重要性を話しました。

伝わったかな?

伝わるといいな。


以上!