プログラミング言語は、それぞれに異なるルールや書き方があります。しかし、言語共通の「良いコードを書くためのルール」も存在します。
コードは動かすためだけに書くわけではありません。
他の人が読みやすくて、メンテナンスしやすい形を意識することも大切です
〇おすすめのプログラミングスクール
ディープロ
ディープロは、現場で使えるスキルを最短で習得できるプログラミングスクールです。実務レベルの設計からプログラミングまで徹底して学べます。メンターへの質問は無制限です。
RUNTEQ
実務レベルのWebエンジニアを育成するオンラインプログラミングスクール。開発会社が運営しており、実践型カリキュラムと手厚い就職支援が特徴です。
WPHack講座
HTML・CSS・WordPressを基礎から学べるオンライン教材。完全サポートコースなら初心者も安心して実践的に習得可能。
今回は、押さえておくべき基本的なルールやコーディングスタイルをわかりやすく紹介します。
プログラミングのルールは言語ごとに違うが共通点も多い
プログラミング言語にはそれぞれ独自の文法や書き方がある一方で、共通点もたくさんあります。
〇変数の宣言と代入
C言語ではint a = 10;
Python ではa = 10
〇制御構文(if, for, while など)
条件分岐やループ処理はほとんどの言語で同じような構文を持っている
たとえば、if-else文やfor文などはほぼ共通している
言語には個性がありますが、基礎的な考え方や構文は共通しているところも多いです
なお、可読性の高いコードは言語を問わず重要です。
簡潔で明瞭なコードは、自分が後で見直す際だけでなく、他の人がコードを理解するときにも役立ちます。
DRYとKISS｜プログラミングにおける原則
プログラミングにおける原則としては、まず「DRY」と「KISS」を理解しておきましょう。
それぞれ詳しく解説します。
DRY（Don’t Repeat Yourself）原則とは
DRY（Don’t Repeat Yourself）は、コード内で同じような処理や情報を繰り返さないプログラミングの原則です。
特にプログラミングを始めたばかりの頃は、同じような処理を何度も書いてしまうことがあります。しかし、これはDRY原則に反します。
DRY原則を意識すれば、同じような処理はひとつの関数やメソッドにまとめられるようになります。変更が必要になった場合に1箇所を修正するだけで済むのもメリットです。
コードの保守性も高まり、バグの発生リスクも減少します
KISS（Keep It Simple, Stupid）原則とは
KISS（Keep It Simple, Stupid）は、「誰でもわかるぐらいシンプルにせよ」という意味合いで使われます。
プログラミングを学び始めると、複雑で洗練されたコードを書きたくなります。しかし、KISSの原則は可能な限りシンプルなアプローチを推奨しています。
シンプルなコードは理解しやすく、後で自分が読み返す際や他の人がコードを見るときにも、すぐに内容を把握できます。
バグを見つけやすく修正も容易です
ただ、KISSは「機能を省略せよ」という意味ではありません。必要な機能は実装ながらも、できるだけシンプルに保つことが大切です。「簡単に書け」という意味でもありません。シンプルなコードを書くには、問題をよく理解して適切な設計をする必要があります。
基本的なコーディングスタイルのルール
基本的なコーディングスタイルのルールを見ていきましょう。
・インデントと空白の使い方
・変数名の命名規則
・一貫性のあるブレース（中括弧）の使用
それぞれ詳しく解説します。
インデントと空白の使い方
インデントとは、コードの各行の先頭に空白やタブを入れて、階層構造を視覚的に表現することです。適切なインデントを使えばコードの構造が明確になり、可読性も大幅に向上します。
多くのプログラミング言語では、ブロック構造を表現するためにインデントを使用します。
一般的には、新しいブロックが始まるたびに、そのブロック内のコードを1レベル右にずらします
インデントには通常、スペースかタブを使用します。どちらを使うかはプロジェクトや言語の慣習によって異なりますが、一貫性を保つことが重要です。
適切な空白の使用も求められます。たとえば、演算子の前後や関数の引数を区切るカンマの後に空白を入れるとコードの要素が明確に区別されて読みやすくなります。
ただし、過剰な空白の使用は避けたほうがいいです。必要以上の空行や不要な空白は、コードの美しさを損なう可能性があります。
不適切なインデントと空白の例を見てみましょう。
多くの開発環境には余分な空白を自動削除する機能があるので活用しましょう
変数名の命名規則
変数名の適切な命名はコードの可読性と保守性を高めます。変数名は説明的でなければいけません。
たとえば、単に「x」や「temp」といった名前ではなく、「userAge」や「totalAmount」のように、変数の内容を適切に表す名前を選ぶ必要があります。
多くのプログラミング言語では、キャメルケース（例：userName）やスネークケース（例：user_name）といった命名規則が使われます。
良い例を見てみましょう。
変数名が説明的で、目的や内容が一目で理解できます。
次に悪い例を見てみましょう。
このような命名方法は、コードの理解を困難にしてバグの原因になる恐れがあります。
〇悪い例の特徴
・変数名が不明確
・一貫性がない
・言語の規則に反している
なお、変数名には、アルファベット、数字、アンダースコアを使えますが、多くの言語では数字で始まる変数名を許可していません。また、予約語は変数名として使用できません。
一貫性のあるブレース（中括弧）の使用
ブレース（中括弧 {} ）の使用も重要なコーディングスタイルのひとつです。
ブレースはコードブロックの始まりと終わりを示すために使われますが、配置方法には主に2つのスタイルがあります。
1つ目は「K&Rスタイル」と呼ばれるものです。開始ブレースを行末に置きます。
2つ目は「Allmanスタイル」と呼ばれるもので、開始ブレースを新しい行の先頭に置きます。
どちらのスタイルを選択するかは、使用するプログラミング言語やプロジェクトの慣習によって異なります。重要なのは、選択したスタイルを一貫して使用することです。
なお、短いブロック（1行のみの処理など）でもブレースを省略せずに使用することをおすすめします。
あとでコードを拡張する際の誤りを防ぎ、一貫性を保てます
複雑な条件分岐や入れ子になった構造を持つコードでは、ブレースの一貫した使用が特に重要です。
変数初期化の重要性
変数の初期化とは、変数を宣言した後で最初に値を代入することです。変数に予測可能で意図した初期状態を与えます。
多くのプログラミング言語では、変数を宣言しただけでは、その変数にどのような値が入っているか保証されません。これは「未初期化の変数」と呼ばれ、予期せぬ動作やエラーの原因となる可能性があります。
カウンターとして使用する変数を考えてみましょう。この変数を0で初期化しないで使うと、予想外の結果になる可能性があります。
適切に初期化を行なえば、予測可能な動作が保証されます
初期化はプログラムの安全性と信頼性を高めるだけでなく、コードの可読性も向上させます。
変数の目的や使用方法も明確になります
初期化の方法は、変数の用途や扱うデータの性質によって異なります。
数値型の変数は多くの場合0で初期化されますが、文字列型の変数は空の文字列で、ブール型の変数はfalseで初期化されるのが一般的です。なお、複雑なデータ型の場合は、適切なコンストラクタを使って初期化します。
変数のスコープと寿命の理解
変数のスコープとは、変数が有効で参照可能な範囲のことです。変数の寿命は、変数がメモリ上に存在する期間を指します。スコープは主にグローバルスコープとローカルスコープに分けられます。
グローバルスコープの変数はプログラム全体で参照可能ですが、ローカルスコープの変数は特定の関数やブロック内でのみ有効です。
変数のスコープを適切に管理すれば、変数の名前の衝突を避けてコードの可読性と保守性を向上させられます。
多くの言語では、変数の寿命はスコープと密接に関連しています。たとえば、ローカル変数は通常、その変数が定義されている関数やブロックの実行が終了すると破棄されます。
一方、グローバル変数はプログラムの実行中は存在し続けます。また、動的に割り当てられたメモリは、明示的に解放されるまで存在し続けます。
変数のスコープと寿命を適切に管理することによってメモリの効率的な使用が可能になり、メモリリークなどの問題も防げます。
変数の使用範囲を限定すれば、コードの理解と保守も容易です
ただし、必要以上に広いスコープを持つ変数は避けましょう。変数が予期せぬ箇所で変更される可能性があり、バグの原因にもなります。
コードを読みやすくするためのコメントアウトの活用方法
コードの活用方法を理解していれば、コードの可読性が高まります。
詳しく見ていきましょう
コメントアウトはメモではなく補足説明
コメントアウトの目的はコードに対する補足説明です。
コードを書いている間や書き終えた直後は、コードの意図や機能が頭に入っているでしょう。しかし、時間が経過すると、複雑なロジックや特殊な処理の意図を思い出せなくなってきます。
他の開発者がコードを読む場合には、意図を正確に理解するのに時間がかかる可能性もあります。
このような問題を避けるためにも、コメントアウトを活用してコードの意図や背景、複雑な処理の説明などを明確に示します。
適切な場所にコメントを入れるコツ
コードの冒頭には、そのプログラムや関数の概要を示すコメントを書きましょう。
複雑な処理や意図が伝わりづらい箇所にもコメントを入れるのがおすすめです。
ループ処理やif文など、制御構造の直前にもコメントを入れると流れがわかりやすくなります。
関数の引数や戻り値の意味を示すコメントも重要です。
コードの内容を単に言い換えただけのコメントや、明白な処理に対するコメントは避けましょう。
過剰なコメントは逆効果になる可能性があります
コメントの定期的な見直しと更新も忘れないようにしましょう。古いコメントが残っていると混乱を招きます。
まとめ
プログラミングには特に難しいはありません。覚えてしまえばサクサクと書けるようになるので、慣れることが何よりも大切です。
おすすめのプログラミングスクール
SkillHacks（スキルハックス）
Webアプリケーション開発向けのプログラミングスクールです。動画形式の授業で細かいニュアンスを丁寧に教えてくれるので、初心者でも安心して学べます。質問対応は無制限・無期限。納得のいく結果が出るまで手厚くサポートしてくれます。
わずか2か月でスキルを習得「SkillHacks」
RaiseTech
最速で稼ぐことを目的としたスクールです。テクニックに頼るのではなく、技術的・人間的に優れたエンジニアの育成を目標にしています。現役の講師による現場主義の教育が特長。実際の現場で必要な技術を習得できるのは大きなメリットです。
最速で稼げるプロになるエンジニアリングスクール【RaiseTech】
Web食いオンラインスクール
自由に学びたい内容を選べるプログラミングスクールです。途中での進路変更も可能。最低契約期間は1ヵ月と短く、縛りがないのも魅力です。添削や回答は無制限で、わかるまでしっかりとサポート。案件が取れない生徒にはスクールが案件を用意するサービスも実施しています。
定額制で質問し放題【Web食いオンラインスクール】
