アカウント名:
パスワード:
コードを書きながらできるだけ詳細にコメントを付ける。 書きあがったらバグ出ししつつコメントも修正する。 できあがったらコメントを読みつつドキュメントを書く。
こうするとソース見ただけで概要がつかめるし、ドキュメントとコードの齟齬もないということでした。 言われたときにはピンとこなかったんですが、先輩の卒論に添付のソースとドキュメントを読んだ時には納得しました。確かに分かりやすいしコードとドキュメントに矛盾がありません。うまい手だと思いました。 でも、現場の進行を考えると時間食い過ぎで採用されにくい方法だと思います。せっかくの知恵なのに。
コーディングしていく過程でどんどん横に流されて当初の設計の名前がふさわしくなくなっても、「最小限以外変えてはいかん」という外的・内的プレッシャーでアホな命名すら、インデントですら、絶対に間違っているコメントすら変えられなかったりする現場も多いのです。自分のソースか、人のソースか、という認識の違いでしょうか。等価変換を一歩踏み出す勇気が欲しいところなんですがこれがなかなか・・・。
より多くのコメントがこの議論にあるかもしれませんが、JavaScriptが有効ではない環境を使用している場合、クラシックなコメントシステム(D1)に設定を変更する必要があります。
日々是ハック也 -- あるハードコアバイナリアン
大学で教わりました。 (スコア:5, 興味深い)
こうするとソース見ただけで概要がつかめるし、ドキュメントとコードの齟齬もないということでした。
言われたときにはピンとこなかったんですが、先輩の卒論に添付のソースとドキュメントを読んだ時には納得しました。確かに分かりやすいしコードとドキュメントに矛盾がありません。うまい手だと思いました。
でも、現場の進行を考えると時間食い過ぎで採用されにくい方法だと思います。せっかくの知恵なのに。
Re:大学で教わりました。 (スコア:0)
コーディングしていく過程でどんどん横に流されて
当初の設計の名前がふさわしくなくなっても、「最小限
以外変えてはいかん」という外的・内的プレッシャーで
アホな命名すら、インデントですら、絶対に間違っている
コメントすら変えられなかったりする現場も多いのです。
自分のソースか、人のソースか、という認識の違いでしょうか。
等価変換を一歩踏み出す勇気が欲しいところなんですが
これがなかなか・・・。