天天看点

【VB.NET机房重构】编程注释

        注释,对于开发人员来说是非常重要的。尤其是初学者,一定要养成写注释的好习惯。因为很多时候代码不只是给自己看,还会给团队伙伴看,可以帮助理解代码含义,发现错误;另一方面,即便是自己看,也有助于回想起设计想法和思路。下面就来介绍一下几种常用的注释方法。(以下都是以VB.NET为例)

    一、基本注释

'调用B层,进行判断
        Dim loginbll As New BLL.LoginBLL '实例化LoginBLL 
           

注释方法:

①直接输入英文字符的单引号,“'”. ②工具栏的常用工具
【VB.NET机房重构】编程注释
③快捷键:Ctrl+K,Ctrl+C。

二、XML注释         <!--****-->(可以自己敲上去,也可以直接点击工具栏的注释工具图标) 例如:

<!--这里写注释-->
           

四、方法注释         一般用于编写函数或方法的时候,在三个单引号之后, 并且会自动检查是否在类或类成员的定义的前面,如果不是,就是简单的基本注释;如果是,则会自动插入注释标记,例如

【VB.NET机房重构】编程注释

五、 头文件注释

          头文件注释是对类的描述,包含内容如下:

【VB.NET机房重构】编程注释

        这种注释是对类整体进行说明,为了一劳永逸,我们可以令其自动生成。在VS的安装路径中找到Class.vb文件,如下所示:

【VB.NET机房重构】编程注释
【VB.NET机房重构】编程注释

        新建类的时候的效果:

【VB.NET机房重构】编程注释

补充: 显示当前时间:$time$(年份+时间) 显示当前创建文件名:$safeitemname$ 显示当前工程名:$safeprojectname$ 显示当前年份:$year$ 小结:         如果你的程序不值得注释,那么它很可能也不值得运行。另外注释应该增加代码的清晰度,简洁明了,不要为注释而注释,让我们的编程更专业。

继续阅读