良質なソースコードを書くのに役立つ記事まとめ

最終更新日:2023年4月24日

プログラマーとして、バグをなくし、読みやすいソースコードを効率良く書く能力はとても大切です。ただ「なぜか自分のソースコードは読みづらいと言われる」「読みやすいコードがどんなものなのかわからない」そんな悩みを抱える方も多いのではないでしょうか?

そこで今回は、コーディングの際に気をつけたいポイントや、スキルアップに役立つメソッドを紹介した記事を特集します!コーディングが苦手な方はぜひ最後まで読んでみてください!

今もらっている年収は高い?低い?

支援実績10年の登録者データを基にした エンジニア・クリエイター専門 年収診断 無料診断START

(1)中級者に読んでほしい良いコードを書くための20箇条

ブログ「anopara」。プログラミング中級者に読んでほしい良いコードを書くための20箇条の画像

プログラマーにとって、"良いコードを書く"は永遠のテーマといっても過言ではないでしょう。
しかし、具体的にどんなことを意識すれば良いかというと、その基準は人それぞれかもしれません。
そこで、「良質なコーディングをする際のヒントが欲しい!」という方のために、ブログ『anopara』の運営者withpopさんが、多くのプログラマーが納得するであろうポイントを《プログラミング中級者に読んでほしい良いコードを書くための20箇条》にまとめられています。

withpopさんが考える良いコードの定義は、「バグのリスクが少なく、シンプルで保守性が高い」ということ。
そして、それを実現するために彼が留意していることが綴られています。

・クラス中のメソッド数を少なくする
・便利な言語機能を使う
・送り出す結果は厳密に、受け取るデータは寛容に
・オブジェクト指向設計する

挙げられている項目は、上記を含めて全部で20。
どれも「なるほど!」と思うことばかりですよ。
バグの頻発に頭を抱えている方や保守性に自信が持てない方は特に、一読してみると参考になるのではないでしょうか。

【参照元】
『anopara』  

(2)効率よくHTMLコーディングができるPugのメリット

ブログ「CNTLOG」。Webデザイナーが効率よくHTMLコーディングができるPugのメリットの画像

『CNTLOG』を運営しているコンチさんは、大阪を拠点に活躍しているWebデザイナー。
HTMLのコーディングをする際には、JavaScriptのテンプレートエンジン"Pug"を使用しています。
コンチさん曰く、「Pugは共通化に優れており、修正や変更がある場合も一箇所を直せば全ページの修正が可能」とのこと。
そのため、保守がしやすく、スピードが求められる案件にも素早く対応できるので、コーディングの質を上げるのにも効果的なんだそうです。

また、CMSの実装やgithubの管理がしやすいというメリットもあるので、効率良くプログラミングを進められるのもポイントなんだとか。
より具体的な"Pug" の魅力については、《Webデザイナーが効率よくHTMLコーディングができるPugのメリット》という記事に紹介されていますので、ぜひチェックしてみてくださいね!

コーディングのスキルアップとともに、今以上に作業の効率化も図れるかもしれませんよ。

【参照元】
『CNTLOG』  

(3)インデントにタブを使うか半角スペースを使うかという話

読みやすいコードを書く際のポイントに、コーディングスタイルを統一するということが挙げられます。
言語によってコーディングスタイルは異なりますが、全体を通して統一感がないと、どんなに工夫を凝らしても可読性は上がらないでしょう。

そこで、コーディングスタイルの1つであるインデントについて書かれた《ソースコードのインデント(字下げ)に、タブを使うか半角スペースを使うかという話》に注目することにしました。

記事内には、一般的なインデントスタイルの紹介やその歴史、メリット・デメリットなどが綴られています。
また、HTML、PHP、Rubyといった言語ごとのインデントスタイルの一覧表も添付されているので、それぞれに違いがあることを把握するのにも役立ちますよ。
ぜひ、キレイで読みやすいコード書きの参考にしてくださいね!

この記事を執筆されたもりやませーたさんは、ブログ『ある蜜柑の上にアルミ缶』の中で、たくさんのプログラミングに関する記事を公開されています。
スキルアップのヒントを探しているエンジニアの方やコーディングの勉強をしている方は、覗いてみると興味深い記事と出会えるのではないでしょうか。

【参照元】
『ある蜜柑の上にアルミ缶』  

(4)まずは「コードの汚さ」の定義からはじめよう

ブログ「高橋文樹.com」。まずは「コードの汚さ」の定義からはじめようの画像

『高橋文樹.com』は、小説家でありながら、Web製作にも精通している高橋文樹さんのサイト。
文芸活動、Web制作、日々の出来事などを綴った記事が掲載されており、休憩時間の読み物やテック系の情報収集にオススメです。

そんな高橋さんのサイトにも、良質なコードを書くときの参考になりそうな記事がありました!
タイトルは《まずは「コードの汚さ」の定義からはじめよう》。
この記事は、ソースコードを読んだときに「汚い」「読みにくい」と感じるポイントにフォーカスしており、キレイで読みやすいコードを書くためのヒントを与えてくれます。

キレイなコードの定義は人によってさまざまかもしれませんが、デキるプログラマーを目指すのであれば、理解しづらいコードを書くことは避けたいですよね。
ぜひ高橋さんの記事を熟読して、美しいソースコードを書くことを意識してみてくださいね。

【参照元】
『高橋文樹.com』  

(5)[PHP]ついやってしまいがちな汚いソース10種

ブログ「PHP ARCHIVE」。[PHP]ついやってしまいがちな汚いソース10種の画像

こちらの《[PHP]ついやってしまいがちな汚いソース10種》も、汚いソースコードについて言及した記事です。
『PHP ARCHIVE』の運営者さんご自身が、うっかりやってしまうコーディングの悪い例を10種類ピックアップしてくれています。

・型を意識しないで変数を使いまわす
・条件分岐やループのネストが深すぎる
・一行に詰め込みすぎる
・複雑な配列変数を一発で宣言する

など、コーディングの経験が浅い方の中には、「自分もやってるかも…」という方もいるのではないでしょうか?
コード書きのスキル向上には経験が欠かせませんが、上記の記事を参考にして、まずは自分のソースコードをチェックすることからはじめることをオススメします。
テクニックも大事ですが、確実に基本を押さえることは、キレイなコード書きの1歩となることでしょう。

【参照元】
『PHP ARCHIVE』 

(6)Railsの中身のコードをコードリーディングする方法

ブログ「ジャバ・ザ・ハットリの日記」。初心者でもカンタンにRailsの中身のコードをコードリーディングする方法の画像

コーディングのスキルを上げるために有効な手段として、「優れたコードをリーディングすること」を多くの優秀なエンジニアたちが推奨しています。
『ジャバ・ザ・ハットリの日記』の運営者ジャバ・ザ・ハットリさんもその考えに賛同する1人。
彼のブログの中の《初心者でもカンタンにRailsの中身のコードをコードリーディングする方法》という記事には、レベルが高いと評判のRailsの中身のコード(DHH氏が書いたRailsのコード)を読むコツが書かれています。

この記事では、RailsモデルのValidationを例に挙げ、Railsの確認用プロジェクトを作り、コードを読み進めながら気になる箇所は定義元に遡ってみるという方法を解説。
ハイレベルなコードを読み解く面白みも書かれているので、スキルアップを目指す方は必見ですよ!

上質なコードに触れると、ライブラリや言語機能の知識を一層深められるので、ひいては質の良いコーディングにもつながるのではないでしょうか。

【参照元】
『ジャバ・ザ・ハットリの日記』  

(7)ビギナーさんに伝えたいコーディングNG集

ブログ「Japanese Style Web Design いろはクロス」。ビギナーさんに伝えたいコーディングNG集の画像

東京でWebデザイナーをしている方が運営している『Japanese Style Web Design いろはクロス』には、デザイン、アート、WordPress、HTMLなどに関する記事がエントリーしています。

仕事や趣味の一環でWeb制作を行っている方は、アクセスすると欲しい情報が得られるかもしれませんよ。

例えばこちらの記事《ビギナーさんに伝えたいコーディングNG集》は、HTMLでのコーディングをマスターしたばかりの方にオススメの記事。

・brの連続打ちでスペースを取る
・htmlタグ内にstyleを直書きする
・見出しや文法の理解が足りない

といった、コーディング初心者が犯しやすいNG例が、やってはいけない理由とともにまとめられています。
ブラウザで表示したときに気になるような崩れがない場合でも、上記のようなNGをしていることがあるんだとか。

慣れるまでは「ちょっとしたことなのに…」と面倒に感じるかもしれませんが、良いコードを書くためには細かい部分への配慮も必要です。
上記のNGまとめを参考にして、自分の書いたコードを見直すと、今まで見落としていたことに気づけるかもしれませんよ!

【参照元】
『Japanese Style Web Design いろはクロス』

ITエンジニア・Webクリエイターの転職ならレバテックキャリア

レバテックキャリアはIT・Web業界のエンジニア・クリエイターを専門とする転職エージェントです。最新の技術情報や業界動向に精通したキャリアアドバイザーが、年収・技術志向・今後のキャリアパス・ワークライフバランスなど、一人ひとりの希望に寄り添いながら転職活動をサポートします。一般公開されていない大手企業や優良企業の非公開求人も多数保有していますので、まずは一度カウンセリングにお越しください。

転職支援サービスに申し込む

また、「初めての転職で、何から始めていいかわからない」「まだ転職するかどうか迷っている」など、転職活動に何らかの不安を抱えている方には、無料の個別相談会も実施しています。キャリアアドバイザーが一対一で、これからのあなたのキャリアを一緒に考えます。お気軽にご相談ください。

「個別相談会」に申し込む

この記事の監修

レバテックキャリア編集部

レバテックキャリアは、IT/Web業界のエンジニア・クリエイター向けに特化した転職エージェントです。当メディアでは、エンジニア・クリエイターの転職に役立つノウハウから、日々のスキルアップや業務に活かせる情報まで、幅広いコンテンツを発信しています。

プロのアドバイザーがあなたのお悩みや疑問にお答えします

- 転職個別相談会開催中 -

相談内容を選択してください

※転職活動や求人への応募を強制することはありません

関連する記事

人気の求人特集

内定率が高い

HTMLコーダーの求人・転職一覧

今もらっている年収は高い?低い?

簡単60秒 エンジニア・クリエイター専門 年収診断 無料診断START ×