skillup

技術ブログ

プログラミング全般

コードの見た目について

投稿日:

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

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

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

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

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

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

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

-プログラミング全般
-

執筆者:


comment

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

関連記事

no image

シェル基礎2

シェルコマンド使い始めて数年たちますが、いまだに知らないことはおおいですし、早く知っとけばよかった的なこともたくさんあります。 そんな小ネタ集を alias よく使うコマンドを別名で登録することができ …

no image

テストのダミーデータ作成

データベースに大量のデータを作りたいときにいつもあああやhoge,aaaですとデータという感じがしないですし、抽出や集計ができません。 なるべく自然に近いデータが欲しいのですが、簡単に作れる方法があり …

no image

1度に1つのことを

今回のリーダブルコードの概念はやや抽象的。 要は一度に行うタスクは1つにする、というところがポイントになります。 そのための手法として下記のようなことを上げています。 コードが行っているタスクをすべて …

no image

Eclipseでのソースフォーマットでの自動改行を防ぐ

小ネタ。Eclipseのソースフォーマッタはディフォルトでは一定の字数で改行されしまい、大変見にくくなったりします。 またHTMLなどでは改行してほしいタグが改行されないなど思ったとおりに動いてくれま …

no image

オブジェクト指向設計 依存関係の管理

オブジェクト指向シリーズ。読みにくい本が多い中でオブジェクト指向設計実践ガイドは勉強になるなー。 Contents1 依存関係の管理1.1 メモ1.2 実際のコーディング上のコツ1.3 感想 依存関係 …