自分で書いたソースが追えなくなる

Question

タイトルの通りです
自分で書いたソースが追えなくなります
その時にスラスラ書いたコードを
3日も見ないと、
全くどういう作りで、思考で、
その時にスラスラ書けたにも関わらず、
全くわからなくなります

色々な開発をしてるわけではなく、一つのWEBページのコードでこのざまです
自分で書いたコードですら読めなくなるのに、人の書いたコードなど読めたものではありません

色んな場面での開発を行ってる方は自分の書いたコードをすぐ理解できるものなんでしょうか？

Answer 1

完全に自分の書いたコード覚えてる人なんて居ないんじゃないかな。

実際3日も見なかったら私もどういう意図でこの処理書いたんだろうってなりますし普通じゃないですかね。
自分が見てもわからなくなりがちなのに他人が見たら普通は理解出来る訳ないので

その時どういう意図で書いたかはコメントで残しておくのが基本じゃないですかね。
そもそも分からなくなるような内容にしないように設計、定義をしっかりしておくのは当然ですが。

###コメントを受けて追記

コメントを残せば劇的に変わるんでしょうか

劇的には変わるかは知りません。自分が趣味で開発始めた時からの癖なので。
ただ、自分の書いたコードをしっかり理解してなければコメント残しても意味はないと思います。
つまり、ネットで拾ってきたコードをそのまま使ったりしてた場合ですね。

意味不明な処理を書いてるけど動いた

これがおかしいです。元々の回答にも書いてますが、コードを書く前にしっかり設計、定義などを
しっかりしておくことは当然です。

考えながら組んでも方向があっちこっちに飛んで元々何がしたかったのかすらわからなくなります。

慣れてないのならまずは追加すべき機能とかは置いといて、とりあえず核となる部分を作り、
そこから新しく追加していけば良いんじゃないですかね？

他人のコードに書いてあったイカした処理はその人の普段の努力によって作られたものです。

理解出来ないものを使うな。自分が使えるものを使え。　って感じですかね。

Comments

[waaaz]

そういうもんなんでしょうか
コメントは残しておりませんでした

コメントを残せば劇的に変わるんでしょうか
例えば100のプロジェクトに携わって、その100のプロジェクトのコードをコメントを残したところで追えるようになるのか？といったら謎です

現状ですが、
意味不明な処理を書いてるけど動いた→あとあと理解できないから書き換えるの蟻地獄のようになっています

[m.ts10806]

>その時どういう意図で書いたか

という具体的なアドバイスが書かれてますよ。

[waaaz]

私はJavaScript使ってますが、
なるべくコメント書きたくないというのも理由の一つです
外部にコメントを公開することになりますし、それは恥ずかしいです
例えばローカルファイルにはコメントは残ってるけど、アップロードする際にコメント部分は消してくれるようなFTPアップローダーはないのでしょうか

[dodox86]

それにしても
> 全くわからなくなります

「3日も見なければ全く」とはどういう状況なのか。本当に全てなのか。さすがに程度問題なのでは。

[waaaz]

ある程度はわかりますが、わからない部分が出てくる
それは当然かもしれませんが、
そういったときに書き換えるハメになったりしませんか？
これを繰り返すことで知能も高まる気もしますが時間のロスも生まれます
だから最初にしっかりしろと言われたらそれまでですが
そんな簡単な事でもない気がします

[m.ts10806]

意味不明で理解できてないコードを公開するほうが私は恥ずかしいです。
それに自意識過剰ではないでしょうか。
他人はそれほど他人に興味を持って他人のものを見ません。
己の要件が満たせるかどうかのみ。

[m.ts10806]

考えてから書けば「書き換える羽目」なんてことにはなりません。
考えながら書くからそうなるだけ。整理されてないあなたのコードまさにそのものではないですか？

[dodox86]

何となく意外と質問者さんにとっては深刻な話のような。コードの背景に何かしら特殊な事情がある場合、一見意味不明に思えるコードでもコメントやドキュメントを読めば理解できるものです。そうではないコードなのであれば、一般的には読んでいる内に思い出せるレベルであると思います。「全く」と言うのは少なくとも個人的にはちょっと考えづらいです。
（興味を持ったのでコメントしましたが、他回答者さんのコメント欄でもあるので、この辺で）

[waaaz]

>他人はそれほど他人に興味を持って他人のものを見ません。
己の要件が満たせるかどうかのみ。

脆弱性が脆弱性がと言って対策してる方々もいる世の中で
コメントを書くことでそれがヒントにもなりうると思いますが
コメントはオープンにすべきではないと思います

[m.ts10806]

動作しているのはコードなのでコメントがダメな理由が分かりません。

[waaaz]

＞何となく意外と質問者さんにとっては深刻な話のような。
よくわかりましたね、自分の脳機能全廃の障害を疑っています
ま、赤の他人から見たらドンマイですね

[waaaz]

＞動作しているのはコードなのでコメントがダメな理由が分かりません。
ヒントを与えてしまうからではないでしょうか

[m.ts10806]

目の前のコード以上のヒントはありません。

[waaaz]

それはかっこつけすぎです

[waaaz]

現実的にコメントのあるなしは
悪意を持ったユーザーにとって
＋でしかない
－にはならないと思います

[waaaz]

コメントは外部に公開する必要がありますか？
ありませんよね？
外部に公開する必要性はどこでしょうか

[waaaz]

＞考えながら組んでも方向があっちこっちに飛んで元々何がしたかったのかすらわからなくなります。

慣れてないのならまずは追加すべき機能とかは置いといて、とりあえず核となる部分を作り、
そこから新しく追加していけば良いんじゃないですかね？

とっ散らかってわからなくなる、というのはわかります
うまくまとめられないというのは脳機能が関係してませんか？

[m.ts10806]

まぁ勝手にしてください。言ってることとやってることが真逆なので、平行線以上近づきそうにないので。

[waaaz]

どの辺が真逆なんですか？
コメントの必要性は感じますが外部に公開したくない、どこがおかしいんでしょうか
素直じゃない奴は知らないって事ですか？

[m.ts10806]

言ってることとやってること
→
言ってることとやりたいこと

本件をきちんと解決するならコメントも適切に書きましょうね
なんですけど、
急に公開にあたってグダグダ出てきて「やりたくないんじゃぁ」では「好きにして」としか言いようがないです。

[K_3578]

>うまくまとめられないというのは脳機能が関係してませんか？

別に私は質問者さんのレベルを知ってるわけじゃないので分かりませんが、
「慣れ」の部分も有ります。後はなんだろう、良い表現が見つからないけど

捻ったコードを書かない、とかかな。

慣れてない内は愚直に基本に倣った実装すれば良いと思います。分からないものを無理に使って混乱するより、分かるものを使うべきです。

んで暫く経ってコードを振り返ったときに「なんだこのクソコードは･･･。」
ってなったら貴方が成長してる証拠だと思います。

[waaaz]

解決するにはあなたのいう通りにしなければならないということでしょうか

[maisumakun]

> コメントの必要性は感じますが外部に公開したくない、どこがおかしいんでしょうか

トランスパイルを挟めば、JavaScriptでもコメントを除外することは可能です。

[waaaz]

＞んで暫く経ってコードを振り返ったときに「なんだこのクソコードは･･･。」
ってなったら貴方が成長してる証拠だと思います。

これがエンドレスに続いた場合は時間のロスにもなります
確かに成長しているのは実感できています

[waaaz]

＞トランスパイルを挟めば、JavaScriptでもコメントを除外することは可能です。
ざっと見ですがまったくわからない領域でした
興味はあるのでじっくり思考したいと思います

[K_3578]

>これがエンドレスに続いた場合は時間のロスにもなります

ある程度で止める、という判断も大事です。私も業務でコード書きますが、全てに於いて完璧なコード
書こうと思ってたら時間がいくらあっても足りませんから。

学習目的でもそうです。リファクタリングするとしても予めどういう風に書き換えるかを決めておくのです。
なんなら紙に書き起こしても良いかもしれません。

[m.ts10806]

> 例えばローカルファイルにはコメントは残ってるけど、アップロードする際にコメント部分は消してくれるようなFTPアップローダーはないのでしょうか

そういうものを自分で作れば良いのでは。
自分の都合の良いものが欲しいのであればそれくらいの気概がないとプログラミングなんてできません。
minifyしてくれるサービスはありますけどFTPアップロード時じゃないですしねぇ。

[waaaz]

自分で作れれば1番いいですよね
もしかしたら、需要ありますよね
オンラインサービスでコピペは面倒ですし

[waaaz]

＞ある程度で止める、という判断も大事です。私も業務でコード書きますが、全てに於いて完璧なコード
書こうと思ってたら時間がいくらあっても足りませんから。

完ぺきなコードを書くというよりも
わからなくなることを無くしたいですね
完ぺきなコードを書くのは有意義ですが
わからなることにかける時間は無意味だと思っています
コメントも、＋でしかないと思いますが、
外部に公開したくないというのは譲れないところです

[K_3578]

私は外部に見られて困るようなコメントは残さないし、重要な処理をそもそも外部が見ることが出来る所で
やらないので。

回答に追記しましたが、例えそれで処理が簡略化出来たとしても分からないものは使わないことです。

[waaaz]

＞外部に見られて困るようなコメントは残さないし
正しいと思います
m.ts10806氏はコメントなんか誰も興味ないとおっしゃいましたが、
気を付けていても重大なコメントが残ることもあります

[waaaz]

開発者側にとってプラスであっても
悪意を持ったユーザーからもコメントは＋でしかないですよ

[K_3578]

私JavaScriptだけで開発したことないのでよく分かりませんが、
JavaScriptだけだと簡単に内容が見られてコメントが公開されたくないなら、
JavaScriptだけでの開発をやめたら良いのでは。

それか、前述してたようにコメントを隠せるようにする事に学習の時間を使われて下さい。

[m.ts10806]

なんでしょうその「重大なコメント」って。
コード以上に重大なものってなんですか？
こういうときのコメントってコードの概要のために使うものではないですか？
何一つ具体的なことを書かずに「書きたくない」と駄々こねてばかりです。
結局何がしたいんですか？
単に設計書めんどくさいコメントめんどくさいだけじゃないですか？
適切なコメント書けるようになってから言ってください。
コードもコメント練習してから公開してください。

[Zuishin]

何だろうこの無意味なこだわり。

悪意を持ったユーザーは読みやすかろうがなかろうが読むので、読みにくいコードを書くことは何の防御にもなってません。

逆に開発者側は読みにくいコードを書くことで同じコードを三日おきに読まねばならず、生産性が犠牲になります。

あえて読みにくくすることはデメリットしかないです。
可読性はできる限り上げていきましょう。

[waaaz]

>JavaScriptだけでの開発をやめたら良いのでは。
色んな言語を組み合わせてます WEBなので
PHPだったらコメントも表示されないし、全然かまわないです

>それか、前述してたようにコメントを隠せるようにする事に学習の時間を使われて下さい。
それは考えましたが手付かずです
既存のものでFTPアップロードするときにコメント部分だけ消せるようなものがあればいいなという思考はありました

[m.ts10806]

>PHPだったらコメントも表示されないし、全然かまわないです
サーバーサイドとクライアントサイドの違いを勉強しましょう。
激しい思い込みからの意味不明な問答。
こういうのを「不毛」と言います。

解決する気なくて自分の主張したいだけになってます。
とれない揚げ足取りを続けて空ぶってるだけです。

[waaaz]

>悪意を持ったユーザーは読みやすかろうがなかろうが読むので、読みにくいコードを書くことは何の防御にもなってません。

んじゃセキュリティエンジニアの存在意義をはなから否定するんですね

[waaaz]

＞サーバーサイドとクライアントサイド
わかってますよ
クライアントサイドなので表示されるからコメント残したくないってことです
わかります？

[Zuishin]

セキュリティーエンジニアに相談してみてください。意味ないって言いますから。

[waaaz]

そんなことはないですね、コメントに限らず
＞読みにくいコードを書くことは何の防御にもなってません。
難読化、暗号化を否定することがあなたにどうしてできるのでしょう

[K_3578]

すいません、クライアントサイド側のコードでそこまで見られて困ることはないと思いますが。

その、隠せるような処理出来るまでローカルで残しとけば良いんじゃないでしょうか。
私自身正直この問答に意味を感じません。

[Zuishin]

teratail にも徳丸さんがいらっしゃるので質問してみたらどうですか？

[waaaz]

＞すいません、クライアントサイド側のコードでそこまで見られて困ることはないと思いますが。
どのようなサイトかによると思います
私のようなサイトでは問題なくとも、現金が絡むサイトなどは問題だと認識します

[K_3578]

>私のようなサイトでは問題なくとも、現金が絡むサイトなどは問題だと認識します

であれば今現在は問題ないのではないでしょうか。
それとも現金が絡むサイトなどを作られるご予定があるのでしょうか。

[waaaz]

＞徳丸さん
先ほどクリップされましたが、すべてにおいて無駄だというんでしょうかね

[waaaz]

＞であれば今現在は問題ないのではないでしょうか。
それとも現金が絡むサイトなどを作られるご予定があるのでしょうか。

今現在とかそういう話じゃなく、コメントは残さないにこしたことはないっていう焦点だと思うんですけど、、、

[maisumakun]

> 私のようなサイトでは問題なくとも、現金が絡むサイトなどは問題だと認識します

そういうサイトでは、「JavaScriptだけでは致命的な動作は何もできない」ようにコードを組んでいます。

[Zuishin]

質問してみてください。回答してもらえるかもしれません。

[waaaz]

徳丸氏、Zuishin氏からの質問です

＞読みにくいコードを書くことは何の防御にもなってません。
難読化、暗号化を否定することができますか
だったらセキュリティエンジニアである徳丸氏の存在など意味ないです
冒涜してるようなものです

[waaaz]

＞そういうサイトでは、「JavaScriptだけでは致命的な動作は何もできない」ようにコードを組んでいます。

わかっています

[waaaz]

セキュリティを高めると同時にセキュリティホールを探し出す徳丸氏
何の防御にもならないなら存在意義を否定されたようなものでは。

[maisumakun]

> 難読化、暗号化を否定することができますか
だったらセキュリティエンジニアである徳丸氏の存在など意味ないです

完全に藁人形論法ですね。セキュリティ全体から考えれば、フロントエンドのJavaScriptコードを難読化するかは些細な問題です（やってもやらなくても、フロントエンドでの処理内容はすべて把握可能です）。

[K_3578]

クライアントサイドのコメント一つをそこまで気にする必要があるでしょうか？

趣味で作っている場合は自分が素早く思い出せるように、
業務で作っている場合は自分以外がコードを弄るときに分かりやすくなるように程度にしか
書いていないので･･･。

申し訳ないのですが自分には質問者さんが何を得たいのか分かりかねます。

[waaaz]

Zuishin氏のクチからはっきり言えばいいんじゃないですかね
JavaScriptに限らず、全て無駄だと。

[maisumakun]

「出来上がってからコメントをすべて削って公開する」ではだめなのですか？

[waaaz]

＞クライアントサイドのコメント一つをそこまで気にする必要があるでしょうか？
ありますから

＞趣味で作っている場合は自分が素早く思い出せるように、
業務で作っている場合は自分以外がコードを弄るときに分かりやすくなるように程度にしか
書いていないので･･･。

申し訳ないのですが自分には質問者さんが何を得たいのか分かりかねます。
仰ることはわかりますが、私は公開したくないのです
だったら「公開しなければいい」ではここまでの議論にはなっていません

[waaaz]

＞「出来上がってからコメントをすべて削って公開する」ではだめなのですか？
それでもいいんです
「コメントなんてどうでもいいだろ」と物申した方がいたので私の考えを伝えただけです

[K_3578]

>だったら「公開しなければいい」ではここまでの議論にはなっていません

私は一応案は提示したつもりですが･･･
ローカル上でだけコメントを残しておく、
除外する処理を理解出来るように勉強する、など
それ以外でも色んな方法をこのコメント欄でコメントしているユーザーの方が提示してくださっています。
それでダメだと言うならば私はこれ以上何かを提案することはできません。

[K_3578]

>「コメントなんてどうでもいいだろ」と物申した方がいたので私の考えを伝えただけです

すいません、そのようなコメントは見当たりませんが私の
「クライアントサイドのコメント一つをそこまで気にする必要があるでしょうか？」
のことでしょうか？

[waaaz]

いえ、「コメント何て誰も気にしてない」的な何かだったと思います

[waaaz]

＞私は一応案は提示したつもりですが･･･
ローカル上でだけコメントを残しておく、
除外する処理を理解出来るように勉強する、など

そこじゃないんですが、もう不毛なのでクローズとさせてください

[K_3578]

この質問と回答によって質問者さんの得たいものを得られなかったのなら残念です。

わかりにくい内容だったかもしれません。申し訳ありません。

[m.ts10806]

>もう不毛なので
自分であちこちに不毛な議論振りまいておいて他人のせいにするとはどうしようもない人だった。

[dodox86]

私には「コメントやドキュメントを書いてポイントを忘れないようにしておこう」と言う、一般的に伝えられる策で対応しきれない、質問者さん特有の問題のことに思えていました。（しばらく目を離していたら驚くほどにコメント投稿が伸びていて、既に終わっていた）

[waaaz]

＞自分であちこちに不毛な議論振りまいておいて他人のせいにするとはどうしようもない人だった。

あなたがこの流れを作った張本人であることを忘れたら駄目ですよ

[m.ts10806]

ちょっと意味がわからない。曲解も酷すぎるし自己主張したいだけだったようだ

[Zuishin]

質問というのはそういう意味じゃなく、要点を整理して新しく質問したらという意味ですが。

[phper.k]

そんなにコメントを書きたくないんだったら、3日後にみてもわかる綺麗なコード書けるようになればいいと思った

[Zuishin]

綺麗なコードだと、悪意のあるユーザーが読めるからダメなんだそうです。

[phper.k]

書いた本人が読めないようなコードってそもそも安全なの？

[Zuishin]

ブラックボックスだとかえってセキュリティーレベル落ちそうですね。
でも彼の脳内のセキュリティエンジニアは難読ソースこそ至高という考えのようです。

[phper.k]

なるほど。
そういうことは、まともに動くソースコード書けるようになってからでいいと思った。

[episteme]

↑同意。

コメントが恥ずかしいなら //～ と /*～*/ を取り除くちょっとしたツール作ればいいんだし。

[退会済みユーザー]

難読化はセキュリティ観点でそれほど重要な意味は持ちません。
JavaScript のそれ系のセキュリティは設計において担保されるべきです。

徳丸さんの直近の回答はこんな感じ
https://teratail.com/questions/339573#reply-467374

まぁ、難読化するツールの中には、コメントを削除するようなものもあるので、コメント削除ツールとしては使えるかもｗ

[miyabi_pudding]

> コメントが恥ずかしいなら //～ と /*～*/ を取り除くちょっとしたツール作ればいいんだし。

これ、以前Gulpで作ったことありますが、自身の実力不足もあり、えらいハマった記憶があります。
パッケージで要件に合うものがなかったので、自作するハメになったという…
（HTMLの圧縮だが、直接<script>書いてたりとか、http://とか、PHP構文混じっててカオスなプロジェクト）

雑談失礼しました。

[m.ts10806]

minifyしてくれるサービスでコメントも自動で消してくれるというのはありますけどね。
いずれにしても元ソースとコメント削除したコードの二重管理になるのは必至でリスク高

[miyabi_pudding]

> コードの二重管理になるのは必至でリスク高

間違いないですね。
コンパイルにせよツール自作にせよ、
自動化すべきですね。
人力で管理するようなものなってしまえば、逆にコストかかりますね。

[K_3578]

なんか雑談的にコメントが伸びてるので便乗しますが

>元ソースとコメント削除したコードの二重管理
これ、自分は現場でありました。元のコード書いた方が既に退職してたので、
ソースを見た時にコメント削除したソースだけどんどん中身書き換わってるのに元ソースが
更新されてなくて相当頭抱えましたね･･･。

[miyabi_pudding]

K_3578さん >
ぐぇ、そのプロジェクトは絶対関わりたくない…
でも、現場では、バージョン管理導入したくない（やり方変えるのめんどい）とか、自動化信用できないからやらない、ってとこも往々にしてありますからね…。

[K_3578]

@miyabi_takatsukさん
今はその現場離れてますが、結局殆ど書き直しましたね･･･。
基本的に管理は全部その退職した人任せで、特に理解してない人達が上から上から
どんどん追加していったのが原因だったみたいです。
「頼むからGitぐらい使ってくれ･･･。」ってなってました

Answer 2

重要なのは「命名」です。
「命名」が正しければ、すべてうまくいきます！

Comments

[waaaz]

命名とは何を指してますか？
すべてうまくいくという根拠はなんですか？

[m.ts10806]

https://ja.wikipedia.org/wiki/%E5%91%BD%E5%90%8D

[Zuishin]

https://teratail.com/questions/339681

確かに、命名の癖を改善するだけでかなり変わりそうです。

[waaaz]

＞Zuishin
うまい指摘してくれましたね

[退会済みユーザー]

うまい指摘をしたのは俺のはずなのに ( ｀皿´)ｷｰｯ!!

Answer 3

設計書の適切な整理、適切なコメント、適切なドキュメントを適切にリアルタイムに対応するだけの話かと思います。

どんなものでも作って終わりではなく、いつまでも自身が関わるとは限らないのではじめの段階で先まで見越して残すものを決めます。
中身を覚えておく必要はなく「これを見れば大体分かる」資料を残すことです。

コメントに関して、その他
下記のような記事、「PHP」が主題ではありますが、他の言語でも、ものによっては日常生活でも置き換えられるような金言もあると思います。
初心者を戒めるPHP
PHP初心者は最低限これはやっとけ - 開発に入る前編

Comments

[m.ts10806]

下書き無しで完璧な構成構図の絵を描けるのはほんの一握りの天才だけなので、我々のような一般人は愚直なほどに丁寧な下書きをするしかないのです。

[waaaz]

まぁ、そういうことなんですね
大工で例えたら設計図もなく思い付きで建築しようとかありえないですよね。。。

[m.ts10806]

人に説明できないコードを正としないことです。
プログラムは書いたとおりにしか動かない。
動くにも動くなりの理由があるし、動かないには動かないなりの理由がある。
その時「なんか知らんけど動いた！だから終わり！」としている今の状態を改善するしかありません。
私は9割以上業務でしかコード書きませんが、半永久的に残ることが必ず頭にあるので、動いた理由・起きた問題・何を調べ何を試したか・解決までのプロセス・自身の思い　何かしらで資料に残します。
本質は問題解決ですし、情報共有です。

[waaaz]

＞プログラムは書いたとおりにしか動かない
それは大間違いです
私が使ったことあるマイナーな言語は
書いたとおりに動かないんですよ
開発者側のバグで。
バグがないと言い切れますか？
あなたの言う書いた通りに動くってのは
書いたとおりに動けばラッキーと私は捉えています

[waaaz]

まぁ、バグ含めそれがあなたのおっしゃる動きであれば
書いたとおりしか動かないといえるかもしれませんね

[m.ts10806]

言語自体にバグがあったとしても、そのときの言語仕様通りに動いてるに違いありません。書いたとおりに動いてます。

[m.ts10806]

>書いたとおりに動けばラッキーと私は捉えています
そんなにありえません。「動くように書く」しかない。
ラッキーに任せてるからこんな質問して意味不明な問答重ねてるんですよ。

[waaaz]

＞そんなにありえません。「動くように書く」しかない。
ラッキーに任せてるからこんな質問して意味不明な問答重ねてるんですよ。

そんなにってことはあるんですよ
あなたは断言してますけど、どう考えてもおかしいと思います
何が意味不明なんですか？あなたにとって理解できないことでしょうか

[waaaz]

何を偉そうに「プログラムは書いたとおりにしか動かない。」なんですか？
そんなに　に　ってことはありうることもわかっておられますよね？
なのに、何が偉そうに「プログラムは書いたとおりにしか動かない。」なんでしょうか？

[maisumakun]

> 私が使ったことあるマイナーな言語は
書いたとおりに動かないんですよ

そんな処理系は投げ捨てましょう。

[m.ts10806]

ほんと、知らんがな。としか言えない。
質問にはまっとうな内容で答えた
回答してる人の意見はおおよそ一致
でも質問者はそれを必死で拒否
なぜそこまで必死にやるべきことをやりたくないのか周囲は困惑

それだけのこと
好きにしてください。
以上。

[waaaz]

＞回答してる人の意見はおよそ一致

それはなぜかわかりますか？
わかりませんよね、だから今のあなたがあるんですよね

[maisumakun]

> わかりませんよね、だから今のあなたがあるんですよね

人について論じたかったのですか？

[waaaz]

215PVに対し低評価がたったの3
（多分これを見てまた増えるでしょうけど）

＞人について論じたかったのですか？
m.ts10806氏にはなぜ触れない？

[m.ts10806]

>色んな場面での開発を行ってる方は自分の書いたコードをすぐ理解できるものなんでしょうか？

についての話はどこにいったんでしょう。
「どうやったら自分のコードでもうまいこと復帰できるようになるか」のアドバイス聞きたいわけじゃなかったなら、そのように質問に書いておいてください。
枝葉に必死になったところでちゃんとしたコードが書けるようにはならないですし、この様子だと10年たっても同じこと言ってそうです。
まぁ他人ですし、本人は聞く耳持たない自分の主張だけ通した人のようなので、どうでもいいのですけど。

[waaaz]

＞「どうやったら自分のコードでもうまいこと復帰できるようになるか」のアドバイス聞きたいわけじゃなかったなら、そのように質問に書いておいてください。

そこから膿が出たんだろ
その流れを作って最終的に投げ出したあなたの罪は重いですぞ

[waaaz]

最後に感想

長いものに巻かれる連中ばかりやな、と
これじゃteratailも廃れるわなぁ
常連がこぞって新参叩きっと
いたたまれないなぁこの構図は
常連には誰も突っ込めないもんねぇ
ま、それはそれでteratailの七不思議の1つで面白いのかなぁと
んじゃ、また

[m.ts10806]

要件と関係ないことに執着され始めたので無視するとして、補足しておくと。

設計書とコードの整合性を完璧にとっておけばコードにコメント書く必要はないので、コード書くことより設計に注力すると良いですね。
コード見なくてもコメント見なくても設計書を確認すればどうなってるか分かるので、ストレスも減るでしょう。
改修時もまず設計書を修正する。コメント○○DocレベルでOK。

[Zuishin]

長いものって何だろう？
オレサマ理論に反対が多かったことを言ってるのかな？

[K_3578]

>m.ts10806さん
結局それでいいと思います。元々コメントって補足程度に書くものなので。

コメントを意地でも公開したくない質問者さんの要望にも合ってると思います。

[m.ts10806]

K_3578さん
補足ありがとうございます。
回答も冒頭設計のことに触れてるので、ちゃんと締めくくれました。めでたしめでたし。