経験値か病院に行くべきか。

Question

プログラムを組んでいるとき、ソース内或いは、ファイル間で似たような記述をすることがあります。

そのようなときは、コピペすることで作業効率が上がるのですが、勉強のためにあえてコピペせずに前に記述したソースをすらすら書けるのか試すことがあります。
しかし、ときどき記述できない時があります。なので前に記述したソースをコピペするわけですが、その書いたソースの意味すら分からなくなることがあるのです。
記憶喪失というと大それておりますが、自分で書いたはずのソースをもう一度じっくり一つ一つ見直すことで、漸くああこういうことがやりたかったのだな、と理解します。
もちろん、ソース一つ一つに邪魔化もしれませんが、注釈をいれてもそのときは、記述しているソースで何をやりたいか理解したうえで書いているので、注釈を読んでも、疑問符が浮かぶことさえあります。

これは、経験でなくなるものなのか、それとも然るべき病院にいくべきなのか。いったいどうなのでしょうか。

Answer 1

こんにちは。

その書いたソースの意味すら分からなくなることがあるのです。
自分で書いたはずのソースをもう一度じっくり一つ一つ見直すことで、漸くああこういうことがやりたかったのだな、と理解します。
注釈をいれてもそのときは、記述しているソースで何をやりたいか理解したうえで書いているので、注釈を読んでも、疑問符が浮かぶことさえあります。

あるあるです。半年くらい前に書いたソースなどは特にその傾向が強いです。
自分で書いたのに意味不明なコメントが時々あるのですよ。１から１０まで全部書いていたら良いのでしょうが、ついついその時に気になっていたことだけを書くものだから、気になっていたことがなんだったのか忘れてしまうと意味不明です。ないよりはかなりましですが、完璧には程遠いのが実態です。
３年くらい前に書いたソースなど自分が書いたという事実さえ思い出せないこともありました。まだ若い頃だったのでちょっとショックでしたけど、大量にソースを書いているとしかたがないことと思っています。

何も知らない人に対して説明するつもりでコメントを書いておけばOKなのですが、なかなかその余裕を持つことができないのも事実ですね。つまり、短時間で的確なコメントをかけるようになることが解と思いますので、これは経験値ではないかと思います。

Answer 2

まず最初に言っておきたいのは、
人間なら忘れて当たり前です！

仕事で使わない人は
学生時代の数学や英語の本が読めない、
というのはよくあることです。

忘れるのがまちがいではありません。
忘れてもいいように書かないのがまちがい。

---

コードを読みやすく書くのは当然として、
リファクタリングする、テストを書いておく、
コメントやドキュメントやUMLなどの図を書く、
というのも後で理解するのに効果的です。

正直、書くときは面倒だと思いますが、
それをやらないと技術的負債になります。

---

コードを読みやすく書く上での心構えがあります。

機械が読むことを想定して書くと、
動けばいいからと書きやすく書きがちです。

人間が読むことを想定して書くと、
書くのは大変ですが、読みやすく書けます。

ひとりで書いても後で自分が読むわけなので、
機械ではなく人間に対して書く
というのは常に意識しておきたいものです。

Answer 3

その時わかったつもりでいて後で見てわからないのは、場当たり的に処理して理解が足らないまま残しているか、よほど注釈の書き方が悪いのか、何か原因があるのでしょう

なんとかしたいのであれば、「誰かに見てもらう」「誰かに説明をする」のも方法のひとつと思います

身近な誰か師となる人を見つけるか、ソースを公開してレビューをお願いするか、とにかく自分以外の誰かに説明し意見を聞いたり直してもらったりすることで、よりよいものになるかと思います

Answer 4

我々が日頃扱っているコードの量を考えると、コーディングの内容や詳細な仕様を暗記するなんて人間業ではありませんし、そんなことにプログラマの脳みそを消費するのはナンセンスです。

だからと言って、コメントに詳細な内容を残すというのも賛成できません。私はコメントについて、以下の様な指針で入れるようにしています。

• 処理内容(ex. // すべての yyy に対して zzz 処理を行う)をコメントに書かない（できるだけ、関数名や変数名を工夫して処理内容がわかるようにする）
• 使っているライブラリやフレームワークの仕様でコードが歪んだ場合にその内容をコメントに残す（ex. // 普通なら xxx ってコーディングすると思うけど、 yyy 関数の仕様で zzz とはならないので注意)
• お客様の事情などで論理や概念モデルが歪んだ場合にその内容をコメントに残す(ex. // ここで、 xxx を入力した場合にエラーになるのは使いづらいというクレームがあり、 xxx は特別に許容することにした)

短く言うと情報量があること（意外性が高いこと）だけをコメントに残しましょうということです。コードを読めばわかることをコメントで入れると、エディタ上の1画面で表示できるコードの量が減り、邪魔なだけです。OSS育ちの人なら余分なコメントを入れたりしないと思いますが、昔のメーカー系のソフトウエア会社の人たちだと、コメント信者の人が多くて閉口します。

Answer 5

おかしくはないんじゃないでしょうか？
最初のうちだけだと思いますよ。
何をやりたいかが理解できれば、とりあえずいいと思います。
書き方は何度もやってれば覚えますし、使わないと忘れます(笑
そしてググって書き方思い出します。

また、自分なら、同じ処理をコピペするのであれば、
処理をまとめられないか？メソッドにして外出しできないか？など考えます。

Answer 6

自分のやりたいことを実現している人のソースコードを借りれば
ソフトはそのように動作しそれで満足することが多いかとは
思いますが、時々基本に立ち返って一行一行の意味を確かめて
みてはいかがでしょうか？

こういうことを繰り返すことにより本当に自分で使えるソース
コードの数が増え経験値になっていくと思います。

そうすれば意味がわからなくなることも減るでしょう。

恐らく病院に行っても根本的な問題は解決しないでしょう。

Answer 7

若年性健忘症とかストレスによる健忘症とかはマジであるので
心配であれば一度病院に行かれた方がいいと思います

それほどでもなければ
「過去の俺が今の俺を超えた」と思いましょう

また

1. コピペしたコードの解らなかったところを解りやすく書き直す
2. 1行に変数を多用している場合は複数行に分割する
3. 変更しても解りにくそうな時はなるべく短いコメントで補足する
4. コピペするときはコメントも一緒にコピペ

これを習慣として行い

if(a == b){//ぶんき、aとbがおなじかくらべているらしい
とかコメントしそうになったら病院へ行きましょう
(その時は手遅れかもしれませんが...)

Answer 8

深夜に閃いたロジックを
翌日に見たら何をしているのか理解できない。

こんなことは日常茶飯事です！

Answer 9

書いた時はキチンと理解しているのに、後から読み返してみると何でこんな書き方をしているのかわからないことは良く有ります。
適切なコメントを入れておけばそれを防ぐ手段になるかもしれませんが、のべつ幕なしにコメントを入れるわけにも行きません。そのうち慣れてくると思います。

ただ、普段の生活に支障をきたすようなレベルの物忘れとなると話が別です。専門医に相談されたほうが良いとお思います。（心療内科など）

Answer 10

プログラムのメンテナンスをしながら、こんなひどいロジック書いたのは誰だ！わかりずらい、作者は誰だと見ると自分だったりします。作成時は、短く詰まったロジックで満足していますが、後で見ると読むには苦労してます。なので少し冗長的に書くようにしています。

Answer 11

要するに
書いた直後は意味がわかっているが、
書いてしばらくしてから読むと意味がわからなくなるということですね。

読みやすいコードを書きましょう。
変数名や関数名にaとかbとかtmpとか適当なもの使ってませんか?

例えば、

$y = (( $x % 4 ) == 0 ) and (( $x % 100 ) != 0) or (( $x % 400 ) == 0);

$isLeapYear = (( $year % 4 ) == 0 ) and (( $year % 100 ) != 0) or (( $year % 400 ) == 0);

まあお決まりのパターンなので上のコードでも閏年判定だとはわかりますが、
下のほうが何がしたいかがよりわかると思います。

「何をしているのか」は名前の工夫でどうにかなります。
(これをコメントで書くと、肝心のコードで手を抜きやすくなるのでおすすめしません。
大きなまとまりの要約程度にしましょう。)
しかし、「なぜその方法をとったのか」はコードを見てもわかりません。
わざわざトリッキーな方法を使わざるを得なかった時はそれをコメントに残しましょう。

Answer 12

後から見て分かるコメントが書けるようになれば解決するのではないでしょうか。
考えて、工夫して、を繰り返さなければ時間だけ過ぎても改善（成長）はしません。
コメントを書く時に「知らない人がコレをみて理解できる」ように情報をそこに明記するような心がけ（配慮）が不足しているのだと思います。
書いてる時に自分が知ってるから、と言うのは書いてる自分の事しか考えていないからです。
読み手の事を考えて書くようにしてみてはどうでしょうか。

Answer 13

内容を読んで思った事がありましたので私見ですが参考になれば。
まずはじめに思ったのが慣れたら無くなるのかもしれないなぁと思いました。(これは人によるかも)

ここからは自分がやっている事ですね。
・元の注釈にその時(書いている時点)は分かっていてもあえてやりたかった事等も記述する。
・一定周期でそのコードを見直す(確か１週間後くらいには記憶量が半分程度になるとかいう記述を見たので)

これは思考放棄かもしれませんが…
・じっくり見れば分かると考え、パッと見で分からない事を気にしない

それでも心配だと思うのであれば病院に行って聞くのもありかもしれません。
(個人的に自分は行きたくないとは思いますが。)