vb.net-study-05 要重视写注释-vb.net程序-Sub过程和Function函数注释

版权声明：本文为博主原创文章，经博主允许，可自由共享，尽量不要用于商业用途。 https://blog.csdn.net/matrixbbs/article/details/91489603

1 注释的生成方式

在Sub过程和Function函数代码开始的上一行连续输入3个英文的分号’’’，就会自动添加注释。
方法
　　1. 先写代码
　　2. 在代码头上敲上’’’（连敲3下单引号键’）
　　3. 全自动生成，只需往里填注释内容即可

或是

2 注释的一般格式

''' <summary>
''' 这里写方法名称或作用
''' </summary>
''' <param name="str">这里写参数说明</param>
Public Sub StuEvaluateCustomEvent(ByVal str As String) '定义触发事件的方法
	RaiseEvent CustomEvent(str) '触发事件
End Sub

''' <summary>
''' 这里写函数名称或作用
''' </summary>
''' <param name="str">这里写参数说明</param>
''' <param name="int">这里写参数说明</param>
''' <returns>这里写对返回值的说明</returns>
Public Function StuEvaluate(ByVal str As String, ByVal int As Integer) As Boolean
	Return True
End Function

3 注释结果

    ''' <summary>
    ''' 求和函数
    ''' </summary>
    ''' <param name="num1">被加数</param>
    ''' <param name="num2">加数</param>
    ''' <returns>和值</returns>
    ''' <remarks> 此部分支持xml格式的描述说明
    ''' </remarks>
    Private Function getSum(ByVal num1 As Integer, ByVal num2 As Integer) As Integer
        Dim sum As Integer
        sum = num1 + num2
        Return sum
    End Function