« Windows 7 : 製品ソフト開発者から出た "その疑問" にズバリお答えします! (第2回) | トップページ | Youtube に TechNet Flash チャネルができました »

2009年10月12日 (月)

[.NET] XML コメントってジャマだ

R・田中一郎さんとこにコメント書いてて思い出した f(^^;
コードを読むときに、 XML コメントってジャマだよねぇ。

へたするとソースコードの半分以上が XML コメントだったりして、 本当に読みたいプログラムコード部分が埋もれちゃってたり。 それでなくても、
・ プログラムコード部分: プログラミング言語、 英語
・ XML コメント部分: 自然言語、 日本語
って違いがあるので、 読む部分によってアタマを切り替えなきゃならん。 ( これが年寄りにはツライのだw )

しかし、 クラスやメソッドのドキュメントを作るためには、 クラスやメソッドのすぐそばに書いてあってメンテしやすい XML コメントは優れものです。
なので、 エディタ上で全ての XML コメントの表示/非表示をワンタッチで切り替えられれば OK なわけですな。 ( 次の画像は Visual Studio 2010 beta のもの。 ひとつひとつを個別に折りたたむことは現在でも可能。 )

すべて表示 (デフォルト)
20091011_vs2010_02
XML コメント 非表示
20091011_vs2010_01

ってことで、 connect に提案を出してみました。 ⇒ FeedbackID=497194: XML ドキュメント コメントの全てを、 1アクションで折りたためるようにして欲しい

※ そんなんアドイン書けよボケ! って話もありましょうが、 Express Edition には通用しないんですよね~。

|

« Windows 7 : 製品ソフト開発者から出た "その疑問" にズバリお答えします! (第2回) | トップページ | Youtube に TechNet Flash チャネルができました »

プログラミング」カテゴリの記事

-プログラミング ( わんくま )」カテゴリの記事

コメント

ドキュメントコメントがウザいなら include の出番かなーとか。

http://msdn.microsoft.com/ja-jp/library/9h8dy30z(VS.80).aspx

投稿: 菊池 | 2009年10月13日 (火) 10時09分

いやぁ、 include 使えばたしかにソースコードはスッキリするけど。 ドキュメントを対象メソッドの隣でメンテ出来る、 っていう XML コメントの最大のメリットを失くしちゃうんだよね f(^^;

投稿: biac | 2009年10月13日 (火) 12時56分

ですよねー
そこで、include しているdocを編集する為の AddIn とか。
それのUIがなぜか痛いとか希望しちゃう駄目な自分。

投稿: 菊池 | 2009年10月13日 (火) 14時04分

コメントを書く



(ウェブ上には掲載しません)


コメントは記事投稿者が公開するまで表示されません。



トラックバック

この記事のトラックバックURL:
http://app.cocolog-nifty.com/t/trackback/209349/46464871

この記事へのトラックバック一覧です: [.NET] XML コメントってジャマだ:

« Windows 7 : 製品ソフト開発者から出た "その疑問" にズバリお答えします! (第2回) | トップページ | Youtube に TechNet Flash チャネルができました »