[PR]

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

2016/07/29
Category : programming

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

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

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

someFunction($id, /* from_admin = */ true);

関数の呼び出しの第2引数の前にインラインコメントが入っています。

someFunction($id, true);

コメントが入っていないと、このtrueが何を表しているのかわかりません。
しかし、

someFunction($id, /* from_admin = */ true);

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

STEP UP BLOG

[PR]

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

Comment0 Comment

Comment Form