skillup

技術ブログ

プログラミング全般

コードの見た目について

投稿日:2016年6月30日 更新日:

リーダブルコード4章。コードの見た目について。

自分は結構注意されますね。多いパターンとしては空白の位置などがいい加減だったり、今はありませんが、以前はコードの末尾にスペースを空けてセミコロンをうつ変な癖がありました。

以下のような点が注意ポイントかと思います。

  • 改行の位置を一貫する
  • 複数の類似データの受け渡し時には=の位置をそろえる
  • SQLを理由がない限りは、縦に情報ごとにインデントしてそろえる
  • 縦にそろえる
  • 類似のメソッドなどは位置を揃える
  • コードはグループごとに切り分け、1グループを長くしない
  • 自分ルールがある場合は必ず一貫性を持たせる

ポイントとしては見た目で頭に負担を与えないこと。

塾で生徒に数学を教えていた時に、ノートの取り方や図の書き方はかなりしつこく指導しました。

それにより情報が見えやすくなり、ミスを発見しやすくなったり、発想が生まれやすくなるからなんですね。一般的に同系統の情報は左→右よりも上→下のほうが処理がおいやすいため方程式などは原則縦にそろえます。それと近い考え方でしょうか。

-プログラミング全般
-

執筆者:


comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

no image

emptyの扱いに関して

PHPで空白や存在確認として便利なemptyですが、乱用すると意図しない動きをすることがあるケースが多々あります。 Contents1 emptyの挙動に関して2 数値の03 検索などの全判定と値のな …

no image

テストコードの書き方の注意点

テストコードを実装する様になって1年ぐらいたったのですが、そこできづいたことなどを。 Contents1 タイトルをわかりやすく2 値をなるべく具体的に書く3 疑似的な仕組みはなるべく避ける(例:Mo …

no image

データ構造の基礎知識 前編 メモリとポインタ、配列と連結リスト

WEB+DB(vol91)で使えそうな連載記事がありますのでブログにメモリます。 テーマはデータ構造です。 Contents1 データ構造とは?2 計算量3 プログラムとメモリ4 配列について4.1 …

no image

abstract,interface,traitなどについて

昔はようわからなかったabstract(継承全般)、interface、traitの使い分けなどについて。 今の現場でいろいろと考えることがあり、自分なりにいろんな方の知見を共有できたので、メモしてお …

no image

JWT(ジョット)の認証に関して

セッションやtokenを使った、認証について色々書いてきましたが、今回はJWTを使った認証について。 Contents1 以前の認証がらみの記事2 JWT(ジョット)とは?2.1 ヘッダー2.2 クレ …

アーカイブ