[PHP] 読みやすいソースコードについて

[PHP] 読みやすいソースコードについて

web

PHPって、HTMLと合わせて書く場合、書き方によってはちょっと視認性が悪い。

こういうコードは読みづらい

ぜんぶechoしている

<?php
    if($honyarara){        
        echo '<div class="honyarara">';
        echo $honyarara;
        echo '</div>';
    }
?>

タグをぜんぶechoしていると、HTMLの構造が把握しづらく、修正が非常にめんどい。

ぜんぶ変数に入れている

<?php
    $honya .= '<div class="honyarara">';
    $honya .= $honyarara;
    $honya .= '</div>';
    echo $honya;
?>

たまに見かける、ぜんぶ変数に入れて最後にechoする書き方。
これも非常に修正しづらい……。関数内なら分かるんだけども。

if文のカッコが分かりづらい

<?php
    if($honyarara) {
?>
    <div class="honyarara">
    <?php echo $honyarara ?>
    </div>
<?php
    }
?>

上記は簡易的な例だけれど、読みにくいし吐き出されるHTMLの構造が分かりにくく、保守もしづらくない??と思った次第です。
二個目の例みたいに、if文の終わり}が独立してしまっていると非常に見づらくてィャ……。

このほうが読みやすい

<?php if( $honyarara ) : ?>
    <div class="honyarara"> 
        <?php echo $honyarara ?>
    </div>
<?php endif; ?>

個人的にはこの書き方のほうがHTMLの構造もif文の終わりも把握しやすいので好きです。
(※あくまで個人的な感想ですが)

チーム作業の場合は適度なルールを作りましょう

この記事はぼくの個人的な好みを主張しただけですが、チーム作業の場合はそううもいきません。
チーム作業で各々が好き勝手な書き方をしてはソースコードがめちゃめちゃになってしまいます。
だからといって、ガチガチにルールを決めてしまえば、効率が悪化したり誰かがストレスを溜めてつぶれてしまうことも。

必要なのは、書き方を限定するのではなく誰もが無理せず・読みやすく・書きやすいルールを最初に定めておくこと。
チームメンバーの読みやすい!修正しやすい!早く帰れる!ハッピー!!が実現できればルールの内容はなんでもよいのです。
必ずなんらかの文書化(gitとかブログでもいいし)して共有し、必要に応じて改定していきましょう。

目次へ戻る