Advent Calendar 2020年の9日目です。
あまり書くことがないため、
ほぼ忘備録のような内容になります。
関数のサマリー
悩ましい問題
関数にサマリー(コメント)を書くことで、
コードヒントに必要なパラメータや関数のチップスを表示することができます。
コードを読めばわかりますが、ロジックを理解するには時間がかかります。
参照元に飛んだり、検索したりするのもなかなか面倒です。
コメントやGitのコミットにコメントを含ませるのも手ですが、
今回はIDEでの開発効率を高める方法をメモ代わりに残します。
解決策
例えば以下のようなFunctionを用意したとします。
Public Function ReturnNumber(ByVal Number As Integer)
Dim Value As Integer = Number
Return Value
End Function
Publicの一行上にカーソルを合わせ、
「'''」と入力すれば、
''' <summary>
''' 引数の数字をシンプルに返すだけ
''' </summary>
''' <param name="Number"></param>
''' <remarks></remarks>
Public Function ReturnNumber(ByVal Number As Integer)
Dim Value As Integer = Number
Return Value
End Function
上のようにXMLが挿入されます。
このFunctionをコーディングすると、
作成したチップスが表示されます。
まとめ
みんなもっとVB.NETを愛そう。
C#でも同様のことできるけど。
MS公式ドキュメント
方法: ドキュメント生成のための XML コメントを挿入する