skillup

技術ブログ

プログラミング全般

コードの見た目について

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

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

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

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

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

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

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

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

-プログラミング全般
-

執筆者:


comment

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

関連記事

no image

シェルの基礎+ユーザー切り替え関連

雑誌を見ていたらシェルの特集があったので、ちょっとメモリます。 補強したいところのみ要点をチェック。 Contents0.1 実行パスについて0.2 ビルドインコマンド0.3 シェル変数・環境変数0. …

no image

命名規則について

リーダブルコードシリーズ第2段、名称について。 コードにおいては名称がとても大切で、正しい命名づけなどはなかなか難しいです。 以下に大事で重要だと思ったポイントを。 Contents1 具体的でわかり …

no image

ログのまとめに関して

何回か書いたログの設計方針に関して再度復習。 ログ設計指針について ログで大事なことを再度復習 DEBUG(SQLやパラメータ情報など詳細な情報までだす)、INFO(メソッドの詳細情報、開始と終了)、 …

no image

便利すぎる道具の弊害

現在、Javaのプロジェクトでは会社でNetbeansを使っていますが、IDEを使っているばっかりに理解できていないところがありました。便利すぎる道具の弊害ですね・・・ IDEについて一応説明をしてお …

no image

トークン認証に関して

Contents1 トークンでの認証2 Laravelでのtoken トークンでの認証 APIアプリケーションを作る場合、認証方式としてはクッキーとセッションを利用したものよりもトークンを使った認証方 …

アーカイブ