はじめに
初めまして。hiroseです。
ほぼプログラミング未経験でIT企業に入社してもうすぐ2年が経とうとしているエンジニアです。
この記事は、私が入社してから重要に感じたことをまとめた記事になります。
同じように業界未経験や入社1年目の方々のお役に立てればと思います。
質問の仕方を考える
丸投げしない
質問は分からないことの答えをそのまま教えてもらうためにするものではなく、
問題を解決するための手助けを得るためにするものです。
必ず自分の考えを質問に付け加えるようにしましょう。
何かを決めなければいけないときに自分だけの判断だけでは決めきれないというのは新人にとってよくあることです。
そんな時に先輩社員に質問をするときに
AとBどちらにするか迷っているのですが、どちらが良いと思いますか？
と質問するのはNGです。
AとBだとAの方がいいと思うのですが、どう思いますか？Aの方がいいと思う理由は…
というように理由もつけて自分の考えを相手に提示しましょう。
状況を報告する
技術的な質問をする際にはピンポイントで分からないことを聞くのではなく、
自分の状況も併せて報告するようにしましょう。
具体的には
- 実現させたいこと
- 試したこと
- エラーが出ている箇所とエラーコード
等を質問に付け加えるようにします。
特にエラーに関してはまずは一度自分でしっかり調べることも大切です。
自分で調べてもわからなく、限界に到達した際に上記のポイントをまとめて質問をしましょう。
公式ドキュメントを読む
プログラミングで分からないものについて調べていると、Qiitaやその他技術的な記事をまとめているサイトがよくヒットします。
しかし、これらの記事を読む前に必ずまず初めに公式ドキュメントを読みましょう。
何故なら人が書いた記事というのは例外なく公式ドキュメントに書かれてあることを基に書かれているからです。
また、公式でないものに関してはそこに書かれていることが100%正しいと言える保証がありません。
プログラミングをしていく上で分からないものを調べる力は非常に重要です。
そして技術的な問題の答えのほとんどは公式ドキュメントに書いてあります。
読みやすいから、という理由で人が書いた記事に答えを求めているといつまでも調べる力が身に付きません。
プログラミングには英語のドキュメントしかないことも少なくなく、それらを読む訓練にもなります。
問題を解決する際は、まずは公式ドキュメントを読みましょう。
コードを読むコツ
コードを読むときのコツは理解したい部分だけ読むのではなく、視野を広げてコードを読むことです。
具体的に言うと
- 理解したいコードが参照されているところ
- 他クラス、他メソッドとの関係性
- クラス名、メソッド名、変数名などの命名部分
等のこと指します。
書かれているコードにはプログラム上で必ず何かしらの役割があります。
その役割は何なのだろう、というのを意識しながら常にコードの全体像を把握するようにしてコードを読んでいくと、理解するまでのスピードが早まります。
コメントを書く
コメントは自分の為にも相手の為にも書くようにしましょう。
自分が書いたコードというのは誰かが読むことになるし、もちろん誰かが書いたコードを自分が読むこともあります。
そんな時にコードにコメントが書かれているか書かれていないかでコードを読解するまでにかかる時間は大きく変わってきます。
自分が書いたコードですら、時間が経ってから読み返してみると他人が書いたコードの様に見えることもあります。
しかし、コメントは愚直に全てのコードに書けばいいというわけではありません。
わざわざ書かなくてもいいコメントを書いてもコードの可読性が落ちるだけです。
コメントを書くコツはコードにはない情報を付け足すことです。
例えば
// 名前を代入する
string name = "hoge";
// 年齢を代入する
int age = 24;
上記のように、コードを読めばわかることにわざわざコメントでコードの説明をするのはNGです。
なので
// 名前の最大文字数は10文字
string name = "hoge";
int age = 24;
等のように、コードだけでは読めない情報を付け加えてあげるようにしましょう。
最後に
エンジニアは日々学ぶことが多い職業です。
先輩から教えてもらった知識、自分で調べて見つけた知識など、得た知識は自分の言葉でまとめ直してメモしておくと物事の再理解に繋がります。
そしていつか、こういう記事を書こうと思った時のネタにもなるので、メモはしっかりしておきましょう。