[.NET] XML コメントってジャマだ
R・田中一郎さんとこにコメント書いてて思い出した f(^^;
コードを読むときに、 XML コメントってジャマだよねぇ。
へたするとソースコードの半分以上が XML コメントだったりして、 本当に読みたいプログラムコード部分が埋もれちゃってたり。 それでなくても、
・ プログラムコード部分: プログラミング言語、 英語
・ XML コメント部分: 自然言語、 日本語
って違いがあるので、 読む部分によってアタマを切り替えなきゃならん。 ( これが年寄りにはツライのだw )
しかし、 クラスやメソッドのドキュメントを作るためには、 クラスやメソッドのすぐそばに書いてあってメンテしやすい XML コメントは優れものです。
なので、 エディタ上で全ての XML コメントの表示/非表示をワンタッチで切り替えられれば OK なわけですな。 ( 次の画像は Visual Studio 2010 beta のもの。 ひとつひとつを個別に折りたたむことは現在でも可能。 )
ってことで、 connect に提案を出してみました。 ⇒ FeedbackID=497194: XML ドキュメント コメントの全てを、 1アクションで折りたためるようにして欲しい
※ そんなんアドイン書けよボケ! って話もありましょうが、 Express Edition には通用しないんですよね~。
| 固定リンク
「プログラミング」カテゴリの記事
- 【.NET / Win8.1 ストアアプリ】 HttpClient で TLS 1.1 / 1.2 に対応するには(2018.06.17)
- 【VS2017 15.7pv2】 XAML のランタイム ツールに 「ヒートマップ」 が増えた(2018.03.28)
- 【.NET Core】 プロジェクトを作ると 「project.assets.json が見つかりません」 エラー(2018.02.10)
- 【#UWP】 ビットマップの表示色を変える (Win2D.uwp 経由で Direct2D を使う)(2017.08.23)
- 【#UWP】 CompactOverlay モード: Picture in Picture というか、「最前面に表示」するウィンドウを作る(2017.08.16)
「-プログラミング ( わんくま )」カテゴリの記事
- [わんくま名古屋] 第21回: Metro サンプルコード解説 (1/3)(2012.04.15)
- [わんくま名古屋] 第21回は 4月 14日 - Windows 8 Metro をやるよ~♪(2012.04.12)
- [わんくま東京] 第59回の資料を公開しました(2011.06.02)
- [わんくま東京] 第59回は 5月 28日 - 名古屋から侵略します♪(2011.05.23)
- [わんくま名古屋] 第17回は 4月 9日 - TDD ネタで喋ります(2011.04.03)
この記事へのコメントは終了しました。
コメント
ですよねー
そこで、include しているdocを編集する為の AddIn とか。
それのUIがなぜか痛いとか希望しちゃう駄目な自分。
投稿: 菊池 | 2009年10月13日 (火) 14時04分
いやぁ、 include 使えばたしかにソースコードはスッキリするけど。 ドキュメントを対象メソッドの隣でメンテ出来る、 っていう XML コメントの最大のメリットを失くしちゃうんだよね f(^^;
投稿: biac | 2009年10月13日 (火) 12時56分
ドキュメントコメントがウザいなら include の出番かなーとか。
http://msdn.microsoft.com/ja-jp/library/9h8dy30z(VS.80).aspx
投稿: 菊池 | 2009年10月13日 (火) 10時09分