【ちゃんなるぶろぐ】社会人1年生が日々の学びをアウトプット!

>>> 読書・遊び・プログラミング・アプリ開発などを通して学んだことを、文章という形で出力 <<<

3分でわかる!「プログラマが知るべき97のこと」その⑥

読み終えるまで約5分

 

 

 

どうも、ちゃんなるです! 

今回も、デキるプログラマを目指し、学んでいきましょう!

 

今回は、次の書籍の一部を要約します。

プログラマが知るべき97のこと』

 

下の記事の続編です↓↓

chan-naru.hatenablog.com

 

 

 

今回選択した3つのテーマ

本書はタイトル通り97のことについて書かれています。

今回は、16~18番目の項目についてまとめます。

  1. コメントについてのコメント(No. 16)
  2. コードに書けないことのみコメントにする(No. 17)
  3. 学び続ける姿勢(No. 18)

 

①コメントについてのコメント

このテーマで述べられていたことは、

「読み手がコードを追わなくてもそのコードの意味がわかる、ためにコメントを入れよう。」

ということです。

 

以下、要約です。

 

『コードは、次に見る人がすぐに理解できるように書く』 

そのために、プログラムのコードには、このコードはどういう目的で書かれたものかを説明する『コメント』を入れるべきです。

 

まずヘッダコメントには「プログラマがコード本体を全く読まなくても利用することはできる」というくらいの情報を盛り込みます。そしてインラインコメントには、自分の次にコードを見て修正や拡張をする人の助けとなるような情報を適宜盛り込みましょう。

(本書33ページより)

 

ただし、コメントは書けばいい訳ではありません。

コードをわかりやすくするために書くので、コメントを入れることでかえって分かりにくくなる場合は入れないようにするべき。

 

 

②コードに書けないことのみコメントにする

このテーマで述べられていたことは、

「コードの意味はコードに語らせよう。それができない場合にのみ、コメントを採用しよう。」

ということです。

 

以下、要約です。

 

コメントを書くことはいいこと、とされますが、コメントを入れたことがかえって害になる場合もあります。

コーディングにおいて重要な技術のひとつに『コメントを書かなくて良いことを見極める』技術があります。

 

不適切なコメントは不適切なコードと違って、修正されたり削除されたりすることが比較的少なく、残ってしまうことが多いです。

不適切なコメントが残っていれば、誰かがそれを見るたびに集中力が削がれたり、コードの解釈を誤ってしまうこともあります。

 

間違ってはないが、コードに何か価値を伝えるわけでもないコメントは、『ノイズ』です。

 

では、『読む人にとって価値がある』とはどういう意味でしょうか? 

 

それは、『コードには書いてないことや、コードにはかけないことが書いてある』ということです。

本来コードを見ればわかるはずのことをコメントに書かなくてはならないのは、コードを見直す必要がある、ということです。

 

コメントを書かずに『コード自身に語らせる』ことも重要なのです!

 

 

③学び続ける姿勢

このテーマで述べられていたことは、

「技術はものすごい速さで変化している。学ばなければ置いていかれるのは確実…!」

ということです。

 

以下、要約です。

 

ソフトウェア開発を仕事にする人は、世界中にいます。

その中で、自分と同じくらいの技術を持った人は、どこにでも、いくらでもいます。

こんな状況下で自分の市場価値を高めるためには、『学び続ける姿勢』がとても重要です。

 

学ぶための具体的な手段を以下に示します。

  • 書籍、雑誌、ブログを読む。TwitterやWebサイトを参考にする。より深い知識は、メーリングリストニュースグループに参加して得る。
  • 身につけたい技術は、自分でコードを書き、手を動かして学ぶ。
  • 自分よりレベルの高い人と仕事をする。周りにいないなら、転職を考える。
  • 師匠になり得る人をネット上で探す。その人がブログをやっているなら、欠かさず目を通す。
  • 自分の使っているライブラリやフレームワークに対する知識を深める。オープンソースなら、コードをデバッガして追うといい。これは頭のいい人たちが書いてレビューを通ったコードを直接目にする絶好のチャンスだ!
  • 何かミスをした時、バグ修正をした時、システムに何か問題を発見したときは、ただ解決するだけでなく、それらについて深く理解する。
  • 自分が学びたいことを人に教えたり、話したりしよう。ユーザグループやカンファレンスに参加し、知識とモチベーションを高めよう。
  • 興味のある言語、技術、分野に関連する勉強会を自ら立ち上げるか、参加する。
  • カンファレンスに積極的に参加する。もし出れなければオンラインで視聴する。
  • 通勤時間が長ければ、ポッドキャストなど音声で学ぶ。
  • 自分のコードに静的解析ツール(リンター)を使う。また、IDE使用中に警告が出るなら、それについて調べる。
  • 『達人プログラマを読み、学んだことを実践する。毎年新たな言語・技術を1つ習得する。新たな知識は新たな発想を生み出す。
  • 学ぶことは、コンピュータ関連の技術でなくてもよい。ビジネス上の問題解決方法でもいいし、仕事の効率を高める技術でもいい。

 

まとめ

①ヘッダコメントにそのコード全体の概要を、インラインコメントに部分の説明を書きましょう!

②コメントを書く場合はその部分のコードを見直してみましょう。コードを書き換えることで、コメントが不要になるかも!

③学び続けよう!置いてかれないように!

 

*より深く知りたい方は、ぜひ本書を手にとってみてください!

書籍情報

プログラマが知るべき97のこと [ ケブリン・ヘニー ]

価格:2,090円
(2021/5/13 11:12時点)
感想(1件)

【中古】 プログラマが知るべき97のこと /ケブリンヘニー【編】,和田卓人【監修】,夏目大【訳】 【中古】afb

価格:825円
(2021/5/13 11:12時点)
感想(0件)

【書籍名】プログラマが知るべき97のこと

【著者名】ケブリン・へニー、夏目大(訳)

【出版社】オーム社

【出版日】2010年12月

【ページ数】243ページ