skillup

技術ブログ

プログラミング全般

コードの見た目について

投稿日:

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

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

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

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

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

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

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

-プログラミング全般
-

執筆者:


comment

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

関連記事

no image

リーダブルコードまとめ

リーダブルコードほぼ読み切ったのでまとめを。チェックリスト化して、常にこれを見ながらコードは書いたほうがよさげ 前半のまとめや参考リンクでみたものとマージします。 Contents1 変数の名称2 コ …

no image

データ構造の基礎知識 中編 ハッシュ

前回の続きです。 前回は配列、連結リストについて学習したので今回はハッシュについて学習します。 Contents1 ハッシュとは?1.1 メリット1.2 デメリット ハッシュとは? key-value …

no image

命名規則について その2

リーダブルコードネタ第3段。 前回のエントリーに引き続き、名称の大切さについて Contents1 あいまいな名前はNG!1.1 限界値はmaxかminを使う1.2 範囲を指定するときはfirstとl …

no image

オブジェクト指向 アプリケーション層に関して

本日も引き続き「現場で役立つシステム設計の原則」を読み進めてます。 本日は主にアプリケーション層(以下AP層)。MVCモデルでいうところのコントローラーに近い?)の考え方について。 Contents1 …

no image

OSコマンドインジェクション

Contents1 OSコマンドインジェクションとは?2 被害3 対策4 参考リンク OSコマンドインジェクションとは? OSに対する命令文を不正に紛れ込ませて攻撃させる手法。 被害 サーバー内のファ …