skillup

技術ブログ

プログラミング全般

コードの見た目について

投稿日:

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

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

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

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

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

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

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

-プログラミング全般
-

執筆者:


comment

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

関連記事

no image

読みやすいコードについて

コードリーディングにおいて聖典となっているリーダブルコードについて読んでいこうかと。 ただ読んでいくだけではつまらないので、自分なりの考え方も書いていきます。 Contents1 優れたコードの定義1 …

no image

エディタatomについて

今までのエディタですが、 gvim eclipse をメインに使ってました(PHPでは)。 エディタとか一旦なれるとなかなか変えにくいのでずっと上記のままでいこうと思ったんですが、今の現場でatomを …

no image

webの仕組み その1 Webの基本的なイメージ

Webの仕組みについて基礎からちょっと勉強しようかと。自分用なのでまとまってません(爆) Contents1 Webの基本的なイメージ2 HTTPメソッド Webの基本的なイメージ ネットワーク上のリ …

no image

トランザクショントークンについて

フォーム画面で入力を行うときにはPOSTでデータを受け取ってエラーチェックしたり、データベースに入力をしたりします。 ただその時に何も考えずに安易に送信→受信の際に以下のようなトラブルがあり得ます。 …

no image

テストコードの考え方

一般的なプログラマにとって日々の業務で何がいやかというと、 理不尽な納期 むちゃくちゃな仕様変更 頻発するバグ・不具合 であることは異論がないでしょう。仕様変更や納期などは自分で何とかしがたい部分もあ …