VB.NET学习笔记:代码注释、Sub过程和Function函数注释、窗体模块类头文件注释

注释能使你的代码更加容易理解,更多时候注释是写给自己看的,相信我,过不了多长时间你就会把编程的思路忘记,有了注释就能加快你的思路回忆。
一、代码注释
很简单,就是用英文的“’”分号开头,可以单独成行,也可以注释到每句代码结束处。如:

Public Class ClsCustomEvent '自定义类
    'Public Delegate Sub CustomEventHandler(ByVal str As String) '声明一个事件的委托
    'Public Event CustomEvent As CustomEventHandler '声明一个自定义事件CustomEvent
    Public Event CustomEvent(ByVal str As String) '声明一个自定义事件CustomEvent
    Public Sub RaiseCustomEvent(ByVal str As String) '定义触发事件的方法
        RaiseEvent CustomEvent(str) '触发事件
    End Sub
End Class

注释的妙用:调试时可以把暂时不想运行的代码注释掉,这样就不用删除代码,想运行该代码再解除注释即可,不用再重新编写。
多行注释技巧:选择需要注释的代码块,然后点击工具栏的“注释选中行”快捷按钮即可为代码添加注释,点击“取消对选中行的注释”快捷按钮可以取消对代码行的注释。
多行注释
二、Sub过程和Function函数注释
在Sub过程和Function函数代码开始的上一行连续输入3个英文的分号’’’,就会自动添加注释。

''' <summary>
    ''' 这里写方法名称或作用
    ''' </summary>
    ''' <param name="str">这里写参数说明</param>
    Public Sub RaiseCustomEvent(ByVal str As String) '定义触发事件的方法
        RaiseEvent CustomEvent(str) '触发事件
    End Sub
    ''' <summary>
    ''' 这里写函数名称或作用
    ''' </summary>
    ''' <param name="str">这里写参数说明</param>
    ''' <param name="int">这里写参数说明</param>
    ''' <returns>这里写对返回值的说明</returns>
    Public Function a(ByVal str As String, ByVal int As Integer) As Boolean
        Return True
    End Function

对Sub过程和Function函数添加注释的好处在于对Sub过程和Function函数进行引用时会有相关提示,提示内容就是你所做的注释,如下图所示,这种提示的好处相信你能明白。
注释
三、窗体、模块、类头文件注释
尔等菜鸟一直采用复制粘贴的形式来添加,其实可以在模板里添加,这样在新建窗体、模块和类时就会自动为窗体、模块和类添加文档注释。
1、 找到你VS的安装目录:c : \Program Files (x86)\Microsoft Visual Studio 11.0。
2、在VS安装路径下依次找到这些文件夹:\Common7\IDE\ItemTemplatesCache。
3、接着找到\VisualBasic\Code\2052\Class文件夹下的Class.vb文件。
说明:模块应该找到\VisualBasic\Code\2052\Module文件夹下的Module.vb文件;窗体应该找到\VisualBasic\Windows Forms\2052\Form文件夹下的Form.vb文件。
4、用记事本或VS打开文件,在文件开头加上你想要的类头注释。如:

'**********************************************
'Copyright (c) $year$$registeredorganization$ All Rights Reserved.
'CLR版本: $clrversion$
'公司名称:$registeredorganization$
'命名空间:$rootnamespace$
'文件名:  $safeitemname$
'版本号:  V1.0.0.0
'版权说明:版权所有,侵权必究!
'创建人:  $username$
'电子邮箱:[email protected]
'创建时间:$time$
'内容:
'功能:
'描述:
'修改日志:
'**********************************************
Public Class $safeitemname$

End Class

如图:
类头注释
5、保存文件,关闭。
新建一个类即可看到效果,如图所示:
效果图
窗体、模块、类模板里常用的参数:
参数 描述
clrversion 当前系统CLR版本号
GUID [1-10] 生成全局唯一标识符,可以生成10个 (例如:guid1)
itemname 打开添加新建项时输入的文件名称
machinename 当前机器的名称(如:XXXX)
registeredorganization 注册的组织名
rootnamespace 命名空间名
safeitemname 保存的文件名
time 当前系统时间,格式:DD/MM/YYYY 00:00:00.
userdomain 用户所在的域
username 当前系统用户名
year 当前系统时间 YYYY

猜你喜欢

转载自blog.csdn.net/zyjq52uys/article/details/85763115
今日推荐