vb.net-study-04 要重视写注释-vb.net程序-如何自动生成类头注释

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

1 头文件注释的要求

注释中必须添加的内容有:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。
类头模板

Public Class $safeitemname$
'**********************************************
'文件名:$safeitemname$
'命名空间:$rootnamespace$
'内容:
'功能:
'文件关系:
'作者:郑丰华
'小组:
'生成日期:$time$
'版本号:V1.0.0.0
'修改日志:
'版权说明:
'**********************************************
End Class

2 位置

C:\Program Files (x86)\Microsoft Visual Studio 10.0\Common7\IDE\ItemTemplatesCache\VisualBasic\Code\2052\Class.zip

有一个叫“Class.vb”的文件

3 注释模板里的参数读解

在这里插入图片描述

4 要重视写解释

1 方便自己日后能快速读解程序,否则,很多需要重学一下
2 方便程序员之间进行有效高效地沟通和交流
3 方便自己深入理解程序,一般应该是先写注解,再写程序
4 不写注解,易容被其他程序员追着砍啊

猜你喜欢

转载自blog.csdn.net/matrixbbs/article/details/91489262
今日推荐