Webエンジニアのスタートラインに立つために必要な、絶対に守るべき7つのルール

ゆるプロ日記 開発 プログラミング
この記事は約5分で読めます。

この記事の最終更新日: 2022年12月30日

ゆるプロ日記 開発

1.コードエディターを使用する

ゆるプロ日記 コードエディター

ほとんどのコード エディターは無料のオープンソースで存在しています。

いくつか試してみて、自分にあったものを利用しましょう。

おすすめのコードエディターは、Visual Studio Code(VSCode)です。

気に入ったコード エディターを見つけたら、コンピューターにインストールしましょう。

2.インデントでコードを綺麗に整える

コーディングにおいて、インデントは重要な意味を持ちます。

インデントをつけることで、コードが読みやすくなります。

コーディングは多くの場合、チームで行うことになります。

コードが適切にインデントされていれば、他の人が読みやすく、理解しやすくなります。

次に、適切なインデントはエラーを回避するのに役立ちます。

コードのインデントが不十分な場合は、バグを見つけて修正する難易度が跳ね上がります。

また、エラーに限らずコードの流れを追跡しやすくなります。

綺麗なインデントを意識して、コーディングするようにしましょう。

3. コメントを残す

コードを書くときは、コードにコメントを付けましょう。

コーディング中に自分の考えをコメントとして落としておくことで、考えの整理や意図を追跡するのに役立ちます。

また、コードを読んだり保守したりする必要がある他の人にとっても役立ちます。

コメントはできるだけ明確かつ簡潔にするようにしましょう。

次に、コメントに残すべき内容を説明します。

コメントはコードがどのように機能するかではなく、コードが何を行うかを説明する必要があります。

また、コメントは簡潔かつ長くする必要があります。

とりとめのないコメントや説明が不十分なコメントは、コメントがまったくない場合と同じくらい理解しにくいです。

ないよりマシとは言いませんが、あっても意味がないものになります。

一般的には、後で戻ってコメントを追加するよりも、コードを記述しながらコメントすることをお勧めします。

こうすることで、元の意図が何であったかを思い出すことが出来、コメントとコードとの関連性が高いものを維持できます。

チームのプロジェクトで作業している場合、スタイルガイドに沿ってコードを残すことが重要です。

全員のコメントが統一性を持ち、理解しやすくなります。

4. 一貫したコーディング規約を使用する

コードを記述するときは、一貫したコーディング規則を使用することが重要です。

これにより、コードが読みやすくなり、自分自身や他の人にとって保守しやすくなります。

コーディング規約は、一般的にはタブやスペースを使用してコードをインデントする、コメントを使用してコードの機能を説明する、変数と関数に一貫した命名規則を使用するなどがあります。

コーディング規則に従うことで、メンバー全員がコードに対してとっつき安くなります。

規則を作成する際、「絶対にこうあるべき」というものばかりではなく、単に決めの問題になるものも多いので、メンバーと相談して開発しやすかったり保守しやすそうな方を選びましょう。

5. 少しわからなければ、Googleで検索する癖をつける(ググる)

コーディングに関して学習するための最良の方法の 1 つは、とりあえず書いてみて、単純に実行することです。

とはいえ、一人で頑張らなければならないというわけではありません。

コーディングの問題で行き詰まったことがあれば、ためらわずにGoogleで検索してみましょう。(これをググるとよく言われます。)

コーディングの素晴らしい点の 1 つは、学ぶべきことが常にあるということです。

どんなに経験豊富でも、常に新しいことを学べます。

このちょっとした検索こそが、新しいことを学ぶ最善の方法なのです。

ですから、次にコーディングの問題に行き詰まったときは、すぐにGoogleで検索してみましょう。

あなたが探している答えがほとんどの確率で見つかります。

6.英語がわからなくても、スタックオーバーフローを使う

Stack Overflowという、コーディングで行き詰まった人が質問し、多くの人が回答してくれるサイトがあります。

このサイトは世界中の人が利用しているため、自分と似たようなバグやエラーで行き詰まった人を探すことができます。

解決の参考になることが非常に多いので、英語のサイトだからといって怖がらず、覗いてみる習慣をつけましょう。

慣れてくれば、自分も質問してみるといいでしょう。

問題に関するできるだけ多くの詳細を含めるようにしてください。

提供する情報が詳細であればあるほど、役立つ回答が見つかる可能性が高くなります。

エラーでハマってしまって、解決の答えが見つからない場合は、恐れずに質問してみましょう。

おそらく、誰かが喜んで助けてくれます。

7. バージョン管理システム(Git)を使用する。

他の開発者と一緒にプロジェクトに取り組んでいる場合は、Gitなどのバージョン管理システム (VCS:version control system) を使用することが重要です。

3人で一つのファイルを編集したいとき、順番待ちの列を作るなど馬鹿馬鹿しいです。

バージョン管理システムを使用すると、開発者はコードベースに加えられた変更を追跡したり、必要に応じて以前のバージョンに戻すことができます。

そのため、バージョン管理システムを使用しない場合に比べて、気が楽に開発できます。(バグが発生しても、とりあえずすぐに戻せるため。)

バージョン管理システムを使用することは、共同ソフトウェア開発の不可欠な部分です。

以上、Webエンジニアのスタートラインに立つために必要な、絶対に守るべき7つのルールでした。

コメント

タイトルとURLをコピーしました