[.NET] XML コメントってジャマだ
R・田中一郎さんとこにコメント書いてて思い出した f(^^;
コードを読むときに、 XML コメントってジャマだよねぇ。
へたするとソースコードの半分以上が XML コメントだったりして、 本当に読みたいプログラムコード部分が埋もれちゃってたり。 それでなくても、
・ プログラムコード部分: プログラミング言語、 英語
・ XML コメント部分: 自然言語、 日本語
って違いがあるので、 読む部分によってアタマを切り替えなきゃならん。 ( これが年寄りにはツライのだw )
しかし、 クラスやメソッドのドキュメントを作るためには、 クラスやメソッドのすぐそばに書いてあってメンテしやすい XML コメントは優れものです。
なので、 エディタ上で全ての XML コメントの表示/非表示をワンタッチで切り替えられれば OK なわけですな。 ( 次の画像は Visual Studio 2010 beta のもの。 ひとつひとつを個別に折りたたむことは現在でも可能。 )
ってことで、 connect に提案を出してみました。 ⇒ FeedbackID=497194: XML ドキュメント コメントの全てを、 1アクションで折りたためるようにして欲しい
※ そんなんアドイン書けよボケ! って話もありましょうが、 Express Edition には通用しないんですよね~。
| 固定リンク
「プログラミング」カテゴリの記事
- [勉強会@名古屋] 明日は、 わんくま同盟 名古屋勉強会 #10 ですよ~。 それと、 スピーカー交代のお知らせ。(2009.11.27)
- [記事] Silverlight 4 があれば Windows はいらなくなるの?(2009.11.27)
- [勉強会@名古屋] Silverlight を囲む会第1回 (2009/11/22) に参加してきました(2009.11.25)
- [.NET] TFS 2010 beta2 日本語版 ~ クライアント OS へのインストールと構成 (その3 : チームプロジェクトの作成)(2009.11.16)
- [.NET] VS2010: 痛 IDE には痛ソース、だよね~(2009.11.20)
「プログラミング ( わんくま )」カテゴリの記事
- [勉強会@名古屋] 明日は、 わんくま同盟 名古屋勉強会 #10 ですよ~。 それと、 スピーカー交代のお知らせ。(2009.11.27)
- [勉強会@名古屋] 11月28日 わんくま同盟 名古屋勉強会 #10(2009.11.08)
- [.NET] XML コメントってジャマだ(2009.10.12)
- [.NET] Silverlight 3 で XAML プレビューが出てこない!? @VS2008SP1(2009.09.02)
- [.NET] VS 2010 and .NET 4 連載 by Scott Guthrie(2009.08.29)
掲示板
blog







コメント
ドキュメントコメントがウザいなら 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分