skillup

技術ブログ

プログラミング全般

コーディングルール 前半まとめ

投稿日:2016年7月7日 更新日:

リーダブルコードを3分の2ぐらいよんだので現時点でのまとめを。

いいコードの定義

リーダブルコードのいいコードの定義は読む人が理解しやすいということだと思います。

シンプルにいうとこれにつきます。ルール同士は干渉したり、衝突することもあるけどこの原則が最優先にくることは間違いないでしょう。

具体的な手法

変数の名称

  • 具体的でわかりやすい名称にする
  • 一般論としてスコープに比例して名前に情報を入れる必要あり
  • 長すぎる場合は短縮形を使ったり、不要な単語を削る
  • フォーマットを決めて形式で情報を伝える
  • 各種よく使われる命名パターンを覚える(最大最小 max or minなど)
  • 否定よりも肯定など、意味がとりやすい名称にする

コード自体の見た目

  • 改行位置を揃える
  • 縦の情報がずれていないようにする
  • 似たような変数は目で見てグルーピングがわかるようにする

コメント

  • 当たり前のことを書かない
  • コメントが冗長になりそうであれば命名などを考える
  • 実例を書く
  • 文章よりは式や箇条書きなど意味が簡潔でわかりやすいものにする
  • クラスやファイル自体は全体像のコメントを書く

制御フロー

  • if文は比較される値を右に。できれば<のほうが見やすい
  • 否定形よりも肯定系で
  • 除外できる結果は早く返す
  • ネストを浅くする

コードの分割

  • 1行に処理が詰まりすぎている場合は変数を使い分割
  • 条件分岐は反転させられないかを考える
  • 条件分岐で処理がありすぎる場合は分割する
  • 別解を考える

変数の使い方

  • 不要な一時変数の削除
  • できるだけスコープを縮める
  • 使用箇所と近い場所での定義
  • 書き込むのは一度だけ(orなるべく数なくする)

-プログラミング全般
-,

執筆者:


comment

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

関連記事

no image

シェル基礎2

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

no image

Oauthについて

今更ながら認証システムの基本などを復習中です。 今回はOauth(オーオース)について。 一般的なWebサービスを使っていると Instagramでのアカウントがある場合、それのアカウントを利用して、 …

no image

API仕様書に関する注意事項

API仕様書を作っていて、基本的な点についてのまとめ コードと連動できれば理想(現実的には設定ファイルをJSONかYamlで作るぐらいが限界だと思う) 型のチェック、必須チェック、桁数チェック、日付の …

no image

プログラミングを習得するときに必要な2つの大事なこと

元々私は塾で仕事をしていましたが、いろいろ紆余曲折ありましていまではWEBエンジニアとして仕事をしております。 エンジニアとしてのキャリアは3年ぐらいなので正直あまりないのですが、開発者と平行してプロ …

no image

SESフリーランスエンジニアのメリデメ

私は現在、一応会社員なのですが、フリーランスに近い立場(案件選択可×単価連動SES)で働いております。 エンジニアの場合、フリーランスといってもエージェント経由でSESで現場に参画していると、決まった …

アーカイブ