.NET TIPS

ブロック・コメント記述時に余計なアスタリスクを挿入しないようにするには?[C#、VS 2005、VS 2008]

デジタルアドバンテージ 遠藤 孝信
2009/10/01

 C#では、コード内におけるコメントの記述方法として、以下の2つがある(カッコ内は具体的な記述方法)。

  • 単一行コメント(// ……コメント……)
  • 区切り記号付きコメント(/* ……コメント…… */)

 このうち後者は一般に「ブロック・コメント」とも呼ばれ、連続する複数の行をコメントアウトしたい場合に利用できる。

Visual Studioでのブロック・コメントの記述

 しかしVisual Studio 2005や2008でブロック・コメントを記述しようとすると、以下の画面に示すように、余計なアスタリスク「*」が自動的に挿入されてしまう。以下の画面は、Form1_Loadメソッドの4行をブロック・コメントによりコメントアウトしようとしているところである。



「/*」を入力



カーソルを「}」の直後に移動



改行([Enter]キーを入力)


改行時に自動挿入される余計な「 * 」
ここではForm1_Loadメソッド全体をブロック・コメント(/* 〜 */)により、コメントアウトしようとしているが、「*/」を記述するために改行を行うと、自動的に「 * 」が挿入されてしまう。

 これはつまり、「/*」を記述した行以降で改行を行った場合、自動的に「 * 」が挿入されるということだ。

 本来この機能は、以下のような形式のXMLドキュメント・コメントを容易に記述するためのものである。このようなブロック・コメントによるXMLドキュメント・コメントの記述についての詳細は、MSDNの「C# プログラミング ガイド:ドキュメント タグの区切り記号」を参照してほしい。

/**
 * <summary>
 * Loadイベント・ハンドラ
 * </summary> */

private void Form1_Load(object sender, EventArgs e)
{

}
ブロック・コメントによるXMLドキュメント・コメントの記述例
C#では、「/// 〜」以外に「/** 〜 */」によってもXMLドキュメント・コメントが記述可能だ。

機能の無効化

 ブロック・コメント記述時にアスタリスクが自動挿入される機能を無効にするには、まずメニューの[ツール]−[オプション]により[オプション]ダイアログを開き、ダイアログ左側のツリーで、[テキスト エディタ]−[C#]−[詳細]を選択する。

 そして、「/// に対するXML ドキュメントを生成する」の項目のチェックをオフにする(デフォルトはオン)。


[オプション]ダイアログ
余計なアスタリスクを挿入させないようにするには、左側のツリーで、[テキスト エディタ]−[C#]−[詳細]を選択し、「/// に対するXML ドキュメントを生成する」の項目のチェックをオフにする。

 しかし当然ながら、この項目をオフにすると、「///」を入力したときにXMLドキュメント・コメントが自動生成されなくなるので注意してほしい。End of Article

カテゴリ:Visual Studio 2005 処理対象:IDE
カテゴリ:Visual Studio 2008 処理対象:IDE

この記事と関連性の高い別の.NET TIPS
[ASP.NET]任意のXMLファイルからサイト・メニューを作成するには?
このリストは、(株)デジタルアドバンテージが開発した
自動関連記事探索システム Jigsaw(ジグソー) により自動抽出したものです。
generated by

「.NET TIPS」

@IT Special

- PR -

TechTargetジャパン

Insider.NET フォーラム 新着記事
  • 第2回 簡潔なコーディングのために (2017/7/26)
     ラムダ式で記述できるメンバの増加、throw式、out変数、タプルなど、C# 7には以前よりもコードを簡潔に記述できるような機能が導入されている
  • 第1回 Visual Studio Codeデバッグの基礎知識 (2017/7/21)
     Node.jsプログラムをデバッグしながら、Visual Studio Codeに統合されているデバッグ機能の基本の「キ」をマスターしよう
  • 第1回 明瞭なコーディングのために (2017/7/19)
     C# 7で追加された新機能の中から、「数値リテラル構文の改善」と「ローカル関数」を紹介する。これらは分かりやすいコードを記述するのに使える
  • Presentation Translator (2017/7/18)
     Presentation TranslatorはPowerPoint用のアドイン。プレゼンテーション時の字幕の付加や、多言語での質疑応答、スライドの翻訳を行える
@ITメールマガジン 新着情報やスタッフのコラムがメールで届きます(無料)
- PR -

イベントカレンダー

PickUpイベント

- PR -

アクセスランキング

もっと見る

ホワイトペーパーTechTargetジャパン

注目のテーマ

Insider.NET 記事ランキング

本日 月間
ソリューションFLASH