忍者ブログ

STEP UP BLOG

Home > ブログ > programming

[PR]

×

[PR]上記の広告は3ヶ月以上新規記事投稿のないブログに表示されています。新しい記事を書く事で広告が消えます。

関数呼び出し時のインラインコメント

職場の勉強会のために「リーダブルコード」を読みました。
新人エンジニアが読むべき◯◯冊に必ず入っている定番書です。
エンジニアになって幾星霜、やっと読みましたよ！
「読みやすいコード」についての指南書となっていて
だいたい納得できることです。

読みやすいコードについて頷くしかないことの連続なんですが、
その中でも初めて出会った書き方があって、
この歳になっても出会いにワクワクできることに感謝しつつ紹介するのが以下のコメントの書き方です。
someFunction($id, /* from_admin = */ true);

関数の呼び出しの第2引数の前にインラインコメントが入っています。
someFunction($id, true);

コメントが入っていないと、このtrueが何を表しているのかわかりません。
しかし、 
someFunction($id, /* from_admin = */ true);

だと、from_admin = true なのだということが一目瞭然です。
わかりやすい〜〜〜
使ってこ！！
PR

anyenvのススメ

いろいろな案件、いろいろな言語で開発していくとそれぞれの言語のバージョン管理に苦しまざるをえないはずです。
プログラミング言語のバージョン管理は、PHPならphpenv、Rubyならrbenv、Pythonならpyenv、Nodeならndenv、
などなど、LL系ならばほとんどの言語において**envの名前で揃っています。
しかしこれらの**envを使っていても、だんだんと**envが多くなってきてため息つきたくなるところ。
そこで便利なのが、**envを管理するanyenvというライブラリです。

https://github.com/riywo/anyenv

GitHubページにも書かれている通り、"all in one for **env"、明快ですね。
インストールはgit cloneしてPATHを通すのみ。簡単ですね。

まずはじめにするのは**env系のインストールです。
$ anyenv install ndenv
$ anyenv install rbenv

これでndenvとrbenvがインストールされます。
確認すると、
$ anyenv versions
ndenv:
* system (set by /Users/takahashi/.anyenv/envs/ndenv/version)
rbenv:
* system (set by /Users/takahashi/.anyenv/envs/rbenv/version)

と表示されます。
ここから、指定のバージョンのNode.jsをインストールしていきましょう。
$ ndenv install 5.12.0
$ anyenv versions
ndenv:
* system (set by /Users/takahashi/.anyenv/envs/ndenv/version)
  5.12.0
rbenv:
* system (set by /Users/takahashi/.anyenv/envs/rbenv/version)
$ node -v
v0.10.16

となります。
この時点ではまだインストールした5.12.0は使えません。
次に、
$ ndenv global 5.12.0
$ anyenv versions
ndenv:
  system
* 5.12.0 (set by /Users/takahashi/.anyenv/envs/ndenv/version)
rbenv:
* system (set by /Users/takahashi/.anyenv/envs/rbenv/version)
$ node -v
v5.12.0

これでインストールした5.12.0のNode.jsが使えるようになりました。
という感じで、他の言語についても同じように使えるので、言語バージョン管理の必要性を感じるようになってきたらanyenvをオススメします。
以上です！
        

PAGE TOP