読みやすいコーディングを心がける

2019年3月25日

ノウハウ

皆さんこんにちは！
今日は頭痛が痛い末ちゃんです。

さて、今回は読みやすいコーディングについてお話ししようと思います。

読みにくいコーディング

最近入社当時にコーディングしたデータを弄ったりすることが多いです。

教えてくれる人もおらず、完全に独学の元で書いていたため、
試行錯誤の中で頑張っていた痕跡をみると、過去の自分に賞賛を送りたいとこですが、
まぁ、メンテナンス性はなく、読みづらく、挙動を推奨しづらいコーディングなため、叱りたいものです。

たかがHTML/CSSのコーディングですらこの始末です。

<div class="item">
  <img src="image.jpg" alt="">
  <div>
    <h2>TITLE</h2>
    <p>text text text text</p>
  </div>
<div>

<style>
.item {
  disdplay: flex;
  align-items: center;
  justify-content: space-between;
}

.item img {
  width: 300px;
}

.item div {
  width: 320px;
}

.item div p:first-child {
  text-align: center;
}
</style>

例で言うとこのようなコーディングが平気でなされていました。
最低ですね。

flexコンテナの直下に画像を設置すると、IE等で画像が伸びるバグがあるため、
テキストブロックが画像より高さをもったら、崩れてしまうだろうし、
画像とテキストブロックのマージンすら指定されていません。

これでは、このブロックの派生型を作りたいことがあっても、
馬鹿のひとつ覚えみたいにCSSを上書きするか、そもそも別のCSSを書かなければ実現できません。

直してみる

これをちょっとはまともに改善してみましょう。
CSSはMind BEMdingで書いてみましょう。

<div class="item">
  <div class="item__media">
    <img src="image.jpg" alt="">
  </div>
  <div class="item__body">
    <h2 class="item__title">TITLE</h2>
    <p class="item__description text--center">text text text text text</p>
  </div>
</div>

<style>
.item {
  display: flex;
  margin: -20px;
}

.item__media {
  flex: 0 0;
  flex: calc(300px - 20px * 2);
  margin: 20px;
}

.item__body {
  flex: 1;
  margin: 20px;
}

.text--center {
  text-align: center !important;
}
</style>

このようになりました。

今度は前記事で書いたようなブロックでエリアを確保して、
その中に要素を格納するスタイルになり、CSSも可読性があがりました。

また、画像とテキストブロックが左右入れ替えるとしても、
親要素に .item–reverse { flex-direction: row-reverse; } を書くだけで実現できます。

<p>の文字列を左揃えにしたかったら、.text–center を外すだけです。