へぼろっぱぁ

脳内容量が少ないTHREE-ONEのための備忘録

ホーム 連絡をする 同期する ( RSS 2.0 ) Login
投稿数  343  : 記事  0  : コメント  862  : トラックバック  60

ニュース

フォクすけぬいぐるみを当ててやる!!
Mozilla Firefox ブラウザ無料ダウンロード
ついでに、みんな FireFox 使えばいいと思うよ。

書庫

日記カテゴリ

Accessory

Community

Private

mxb さんの CSS コーディング規約見てました。
んで、常々思ってたんですがヘッダコメントとか必要ですかね?
クラスにしろ css にしろ JavaScript にしろ
あ、ソース管理システム使ってないとか、コメントで変更履歴(笑)な環境は除外してます。
クラスなんかの場合、ドキュメントコメントに書けばいいのにわざわざヘッダコメントに書いてあるとか意味わかりません。
修正の度に最終更新日変更しなきゃならないとか面倒です。
そもそも作成者と作成日になんの意味があるんでしょう?どうせもういないのに
変更履歴のコメントに助けられたことはあっても、ヘッダコメントに助けられたことは一切ありません。
今のプロジェクトは変更履歴の概要をヘッダコメントに書くことになっています。
クラスファイルを開くと、ヘッダコメントと using で一画面埋まってるとかうんざりします。
確かに全般的な説明がほしい場合はあります。
css とか JavaScript とかはドキュメントコメントのような機能はありませんしね。
それでも、簡潔に1~3行程度で十分ですので

以上、VSからファイルを開いたら一面緑文字オンリーで「なんかもうやってらんね」な気分になった人の戯言でした
投稿日時 : 2008年4月24日 1:48

コメント

# re: ヘッダコメント 2008/04/24 2:08 中博俊
まったく。
無駄なコメントは削除すべきです。
冗長なことは守れない=>実態とかい離する=>そんなものいらない
なのでソースヘッダコメントなんてごみです。


# re: ヘッダコメント 2008/04/24 2:41 NAL-6295
同意です。

>冗長なことは守れない=>実態とかい離する=>そんなものいらない

まさしく。

# re: ヘッダコメント 2008/04/24 8:52 じゃんぬねっと
CSS はヘッドコメントのパターンが多いですね。
Blog サービスだと大抵そう。

# re: ヘッダコメント 2008/04/25 22:51 THREE-ONE
>中さん
> 冗長なことは守れない=>実態とかい離する=>そんなものいらない
これがすべてですね。

>じゃんぬさん
Blog サービスとかは対象がユーザーですからね。ちょっと別視点のヘッダコメントのように思います。

Post Feedback

タイトル
名前
Url:
コメント: