男子社会人のひとりよがり

名前:わたMAN   職業:大学生  時事ネタや自分の趣味などさまざまなジャンルを書くかもしれませんがお許しください。

【プログラマー必見】読みやすい綺麗なコードを書くために読むべきQiitaの記事まとめ5選!

スポンサーリンク

こんにちは!わたMANです。

 

私は本業プログラマーとして、日々業務に励んでいるのですが、まだまだ半人前なので勉強することばかりです。

 

業務で使用しているプログラミング言語はC#なので、これまではC#の勉強を中心に行ってきました。

 

勉強し始めてから約1年ぐらいになり、ある程度基礎的な構文は分かるようになりました。

 

 

そのため、今はどのようにしたら読みやすくて綺麗なコードを書けるかについて勉強するようになりました。

 

そこで今回は、読みやすい綺麗なコードを書くために読むべきQiitaの記事を5つ紹介していきたいと思います。

 

 

 

【脱初心者】読みやすく綺麗なコードを書くコツまとめ

qiita.com

 

プログラマ初心者の方が、少しでも良いコードを書けるようになるために読んでほしい記事です。

 

記事の目次

◇ソースコードを見やすくするために心がけておくこと

 ・良いコードとは

 ・なぜ良いコードでなければいけないのか

 ・同じコードを複数書かない

 ・分かりやすい変数名やメソッド名を付ける

 ・インデントをしっかりとつける

 ・コメントの付けすぎはダメ!!

 ・不要なコードはコメントアウトで処理しない

◇マジックナンバーは使わない

 ・マジックナンバーとは

 ・なぜ使ってはいけないのか

◇ネストを深くしすぎない

 ・ネストとは

 ・なぜネストが深くなるのか

 ・どうすればいいのか(具体例あり)

◇制御の見通しが悪くなるようなgoto文を書かない(C#)

 ・なぜgoto文を書かないのか

 

良いコードを書く技術(まとめ)

qiita.com

 

良いコードを書く技術という本を踏まえて、筆者の経験などを交えながらコードの書き方を知れる記事です。

 

記事の目次

◇まず良いコードとはなんだろうか?

◇未来の自分に向けて読みやすいコードを書こう!!

◇第一章

 ・変数名は多少長くても理解しやすいようにしたほうが絶対良い

 ・変数名は愛情!

◇第二章

 ・習慣その1 読む

  ・コードを読んで読みまくれ!!

 ・習慣その2 書く

 ・習慣その3 道具を磨く

 ・習慣その4 知る

 ・習慣その5 聞く(教える)

   ・まずは隣の人に教えよう!!

  ・コードレビューを受ける

◇第三章

 ・1、長すぎず、短すぎず

 ・2、意味の通じる名前に!かっこいいだけじゃダメ

 ・3、一貫性がある

 ・4、英語で付けられている

 ・5、変数名

◇第四章 スコープ

 ・スコープは簡単にいうと変数の有効範囲です!!

 ・numberの有効範囲はどこまででしょう?

◇第五章 コードの分割

◇第六章 コードの集約化

 

きれいなコードとは? リファクタリングできれいなコードを書く方法

qiita.com

 

 「きれいなコードって言われてもよくわからない」という人に、「もっと、きれいなコードの条件を知りたい!」「リファクタリングをしてみたい!」と思ってもらえるような記事です。

 

記事の目次

◇きれいなコードってどんなもの?

◇きれいなコードの条件

 ・同じ処理はまとめる。繰り返し書かない

 ・ネストと浅くする

 ・変数名・関数名を分かりやすくする

 ・その他

◇常にきれいなコードを書けるわけではない

◇リファクタリングしてみよう

 ・リファクタリングとは

 ・リファクタリングの始め方

◇どんなことをしたか

 ・自分で書いたコードをとにかくリファクタリングしてみる

 ・今あるコードをリファクタリングしてみる

 ・きれいなコードの書き方を学び、使ってみる

◇リファクタリングをしてよかったこと

 ・言語・フレームワークの理解が深まった

 ・プロジェクトのソースコードの理解が深まった

 ・コードレビューで指摘される回数が減った

 ・修正が簡単になった

 

リーダブルコード要約とリーダブルコード要約の活用方法

qiita.com

 

 リーダブルコードというプログラマーならば絶対に読むべき技術書の要約と、その要約の活用方法について書いてある本です。

 

記事の目次

◇対象者

◇リーダブルコードの特徴

◇さらなるリーダブルコード活用方法

◇本書の目的

◇1章 理解しやすいコード

◇2章 名前に情報を詰め込む

◇3章 誤解されない名前

◇4章 美しさ

◇5章 コメントすべきことを知る

 ・価値のあるコメント

 ・価値のないコメント

 ・定数にはコメントをつける

 ・読み手の立場になって考える

 ・コメントを書く作業は以下の3つ分類できる

◇6章 コメントは正確で簡潔に

◇7章 制御フローを読みやすくする

 ・ifの並び順の指針

 ・ヨーダ記法はIDEを使用する前提であれば警告をだすので不要

 ・三項演算子

  ・メリット

  ・デメリット

 ・指針

 ・do~whileループは避ける

 ・関数から早く返す

 ・ネストを浅くする

◇8章 巨大な式を分割する

 ・説明変数を用いて分割する

 ・要約変数を用いて分割する

 ・短絡評価の悪用

◇9章 変数と読みやすさ

 ・制御フロー変数を削除する

 ・変数のスコープを縮める

 ・メンバ変数も極力さける

 ・JavaScriptでプライベート変数を作る

 ・JavaScriptのグローバルスコープ

 ・PythonとJavaScriptのネストしないスコープ

 ・定義の位置を下げる

 ・変数は一度だけ書き込む

◇10章 無関係の会問題を抽出する 

 ・メソッドの抽出

 ・純粋なユーティリティコード

◇11章 一度にひとつのことを

◇12章 コードに思いをこめる

◇13章 短いコードを書く

 ・鍵となる考え:最も読みやすいコードは何も書かれていないコードだ

◇14章 テストと読みやすさ

 ・テストに優しい開発

 ・テストコードのやりすぎに注意

◇15章 「分/時間カウンタ」を設計・実装する

 ・外部の視点を得る

 

ソースコードを美しくデザインする

qiita.com

 

この記事でいうデザインとは、コードの見た目のことです。

ソースコードの整形について書かれている記事はあまり見かけないのでおすすめです。

 

記事の目次

◇デザインのおさらい
◇良いコードとは
◇美しさを表現するための基本メソッド
◇何を置いても一貫性が大事
◇視線の誘導を意識する
◇ルールによって要素を整列させる
◇グルーピングで概要を素早く掴む
◇優先順位をつける 

 

まとめ

f:id:herawata:20190518180803p:plain

今回は、読みやすい綺麗なコードを書くために読むべきQiitaの記事を5つ紹介していきました。

プログラミングにある程度慣れてきて、もっと綺麗なコードを書けるようになりたい方はぜひ参考にしてみてください。

 

綺麗なコードを読むと、芸術作品みたいな感じで感動してしまうこともあります。

自己満足にすぎないかもしれませんが、他人が読んでわかりやすいコードにする工夫はプログラマーとして必要なスキルだと思います。

 

私自信も美しいコードを書くために尽力していきます。

 

最後まで読んでくれてありがとうございました。

よかったら読者登録よろしくお願いします。

 

プログラミング関連記事

 

よく読まれている記事