アカウント名:
パスワード:
いろいろとコメントがごちゃごちゃ書いてあるけど、結局なにがどうなって現時点でどうなっているのかがよくわからないコメントにお目にかかったことが何度かある。コメント内容から今どうなっているのかが分かるだけまだマシなのかも知れない。
私が担当しているシステムには、下記のようにコメンがありますが、見事にXとYが入れ替わってるソースがあります。#しかも2か所同じようなものがあるが、片方は正しく書いてあるという・・・(笑)#元からコメントは参考程度にしかならない(画面コピーしかない設計書も役に立たないのでソース読め状態)ので誰も(私も含めて)コメントを書き換える人がいない(笑)
Select Value Case 1 //X-Aです Case 2 //X-Bです Case 10 //Y-Aです Case 11 //Y-Bです End Select
ごちゃごちゃになるのは元ソースのテストが不完全だったか仕様変更が頻繁な場合ではないかと。この方法は有効だし残ると思う。VCS使っていても変更行のbegin/endにレポジトリと同じコメント名で残せばテキスト一発で変更を検索できるのが利点。前提として本番動作中のコードがテストを通った後でそうそう頻繁に更新がかからないのが条件かなと。大規模な改修なら再度総合テストが通るから履歴コメントを残さなくても良いというルールがあればそれほど、コメントで肥大化することも無いとは思う。どうだろうか。
より多くのコメントがこの議論にあるかもしれませんが、JavaScriptが有効ではない環境を使用している場合、クラシックなコメントシステム(D1)に設定を変更する必要があります。
身近な人の偉大さは半減する -- あるアレゲ人
コメントでも追うことが出来れば (スコア:2)
いろいろとコメントがごちゃごちゃ書いてあるけど、結局なにがどうなって現時点でどうなっているのかがよくわからないコメントにお目にかかったことが何度かある。
コメント内容から今どうなっているのかが分かるだけまだマシなのかも知れない。
Re:コメントでも追うことが出来れば (スコア:2)
私が担当しているシステムには、下記のようにコメンがありますが、見事にXとYが入れ替わってるソースがあります。
#しかも2か所同じようなものがあるが、片方は正しく書いてあるという・・・(笑)
#元からコメントは参考程度にしかならない(画面コピーしかない設計書も役に立たないのでソース読め状態)ので誰も(私も含めて)コメントを書き換える人がいない(笑)
Select Value
Case 1 //X-Aです
Case 2 //X-Bです
Case 10 //Y-Aです
Case 11 //Y-Bです
End Select
Re: (スコア:0)
ごちゃごちゃになるのは元ソースのテストが不完全だったか仕様変更が頻繁な場合ではないかと。この方法は有効だし残ると思う。
VCS使っていても変更行のbegin/endにレポジトリと同じコメント名で残せばテキスト一発で変更を検索できるのが利点。
前提として本番動作中のコードがテストを通った後でそうそう頻繁に更新がかからないのが条件かなと。
大規模な改修なら再度総合テストが通るから履歴コメントを残さなくても良いというルールがあればそれほど、コメントで
肥大化することも無いとは思う。どうだろうか。