C#,VB.NET コメントを入力するサンプル

Visual Studioのコメントを入力する/解除するサンプルです。

目次

サンプル 複数行をコメントにする/解除する
  メソッドのサマリのコメントの型を自動入力する

複数行をコメントにする/解除する

1.複数行をコメントにする手順です。
コメントにしたい行を選択します。

 

2.赤枠の箇所のアイコンをクリックするとコメントになります。
Ctrl + k を押してからCtrl + cでもできます。

 

3.コメントを解除する場合は、コメントを解除したい行を選択し赤枠の箇所のアイコンをクリックするとコメントが解除されます。
Ctrl + k を押してからCtrl + uでもできます。

 

メソッドのサマリのコメントの型を自動入力する

メソッドのサマリのコメントの型を自動入力するサンプルです。

2行目のようにメソッドの前で、以下を入力します。
・VB.NETの場合は、シングルコーテーション(')を3つ入力する
・C#の場合は、スラッシュ(/)を3つ入力する

Public Class Class1
'''
	Function Test(ByVal num1, ByVal num2, ByVal num3) As Integer
		Return num1 + num2 + num3
	End Function
End Class

 

以下の2~8行目のようにメソッドのサマリのコメント欄が自動で入力されます。

Public Class Class1
	''' <summary>
	''' 
	''' </summary>
	''' <param name="num1"></param>
	''' <param name="num2"></param>
	''' <param name="num3"></param>
	''' <returns></returns>
	Function Test(ByVal num1, ByVal num2, ByVal num3) As Integer
		Return num1 + num2 + num3
	End Function
End Class

3行目のsummaryは、概要を入力します。
5~7行目のparamは、引数の説明を入力します。
8行目のreturnsは、戻り値の説明を入力します。

以下は、Microsoftの「方法: ドキュメント生成のための XML コメントを挿入する」のリンクです。
https://docs.microsoft.com/ja-jp/visualstudio/ide/reference/generate-xml-documentation-comments?view=vs-2019

関連の記事

Visual Studio デバッグの方法

△上に戻る