やあ子供達、元気にしてたかい。みんなはスコープをちゃんと使っているか。局所的にのみ使用する変数とその処理はスコープを切ってその中で簡潔させるように徹底してコードを書くととても見やすくなるぞ。
そんなこんなで日々重宝するスコープなわけだが、コードを書いてると個々のスコープの中で行っている処理についてコメント説明をその冒頭に入れたくなるケースがよく出てくるわけだ。
おじさんはそれをスコープの始まる直前に書くべきかスコープの中に書くべきかということを日々考えていたのだけれども、ついに前者の方に徹底しようという結論に達したぞ。
// ●書き方その1 // 以下のスコープの説明 { // コード‥ // 以下の「スコープの中のスコープ」の説明 { // コード‥ } } // ●書き方その2 { // 本スコープの処理の中身の説明 // コード‥ { // 本「スコープの中のスコープ」の説明 // コード‥ } }
その理由はとても簡単だ。その理由とは、「一行のみで完結する処理もあるわけでそういう場合はいちいちスコープを切ってらんないから。そういう場合はコメント書いてその一行を書いての2行で完結したいから。」だ!
// 以下1行の説明 func(); // 以下スコープの説明 { // コード‥ }
この状況からルールを抽出してみるとつまり、コメントと、実際の処理かたまりであるスコープ定義とは、インテント的に同階層に書くということになるね。そう、つまりスコープの中の処理に関する説明をそのスコープ自身の中に書くというルールはこの時点で却下されたというわけさ。
というわけでみんなスコープを使おうぜ。スコープも切らずに使わない変数をだらだらでかいスコープの中で定義しっぱなしというコードはとても読みにくいし、書いてても楽しくないぞ。なので今日書いたことはみんな気をつけてくれ。よろしく頼むぞ。じゃっ!