ソースコードは改行とコメントアウトで他人でも見やすいような書き方をしよう!

スポンサーリンク

プログラミングを覚えたての初心者のほとんどは、何も気にせずにガリガリとコーディングを進めているかもしれません。

しかし、もしもプログラミングを使って働くことになったとき。
あるいは、個人で趣味なり仕事なりで今後使っていくことになったとしたら。

自分が以前に書いたコードを見て必ずこう思ってしまう瞬間があります。

あれ?この処理何やってるんだっけ?

そうならないためにも、今回は改行コメントアウトの重要さについて解説していきます。

読みやすいソースコードに改行は必須

改行した方が見やすいというのは、ソースコードに限った話ではありませんよね。

文章だって適度に改行するからこそ読みやすいわけです。
最低限のマナーと言ってもいいかもしれませんね。

ソースコードでも同様のことが言えます。
個人で開発するからいいや!という意見もあるかもしれませんが、個人で開発していても過去に書いたコードを見直さなければいけない場面も少なからずあるはずです。

そうなったらもう他人が書いたコードと変わらないですよ。

実際に改行を使ってみた例

WordPressデフォルトテーマのTwenty Seventeeのfunctions.phpを見ると、以下のようなコードがあります。

/*
* Enable support for Post Formats.
*
* See: https://codex.wordpress.org/Post_Formats
*/
add_theme_support( 'post-formats', array(
'aside',
'image',
'video',
'quote',
'link',
'gallery',
'audio',
) );
// Add theme support for Custom Logo.
add_theme_support( 'custom-logo', array(
'width'       => 250,
'height'      => 250,
'flex-width'  => true,
) );

見ての通りしっかり改行されています!
ちなみにスペースは半角スペースです。

全角スペースは文字なので半角スペースと同じ想定で使うとエラーになってしまいますが、半角スペースだったらいくら使っても問題ないです。

処理に負荷がかかるわけでもないですし、見やすくなるんだったらどんどん使っていきましょう。

コメントアウトで処理の解説を残しておこう

上記のコード例を見ると分かりますが、しっかりコメントが書いてありますね。

ちなみにコメントアウトというのは、コードを認識されないように除外する記述のことです。
PHPの場合は、上記のように//(その行を丸々コメントアウト)や/* hoge */(/*と*/の間は全てコメントアウト)のように囲って使います。

コメントの下のコードが何をやっているのか英語で書かれていますね。
基本的にはこれを真似しましょう。
(もちろん英語じゃなくて日本語で記述して大丈夫です!)

働くことになったら、現場ではこのコメントアウトの部分に改修日改修者所属チームや担当会社名などの情報を残すことになると思います。

まだ働いていないけどこれから働くという人も、習慣づけのために今から残せる情報は残しておきましょう。

コメントの書きすぎには注意

例えば以下のようなコメントの書き方は最悪です。

// カスタムロゴをカスタマイズ画面に実装する
add_theme_support( 'custom-logo', array(
// 横幅を250pxに設定
'width'       => 250,
// 高さを250pxに設定
'height'      => 250,
// 横幅をフレキシブルに
'flex-width'  => true,
) );

どう見ても鬱陶しいですよね!笑
ここまで来ると逆に見にくいです。

コメントアウトは塊ごと…つまり改行のタイミングですればいいと思うので、ここまで詳細なコメントは必要ないです。

ない方が見やすいですからね。

まとめ

見やすいソースコードにするには
改行・半角スペースとコメントアウトを使いこなして見やすいソースコードを書くように心がけよう

きれいなソースコードを書きましょう!

スポンサーリンク
スポンサーリンク