SQL Server 为存储过程添加预定设置注释代码

 

 

一个优秀的项目最少不了的是代码注释，兴许你是代码高手入目既知道该段代码主要功能是什么，但日子长了，记的东西多了，即时再熟悉的代码也渐渐的有点不认 识它，所以养成良好的写注释的习惯，对于自己对于他人都是好的。借着这个话题，我也就献丑一下为我们同胞们分享一下我自己一下注释方面的经验。以 mssql的存储过程为例：

先弄个成果给大家看看：

当你随便创建一个存储过程时就会自动给你的存储过程中添加上以上的注释代码。如此看来也便于管理了解该存储过程的功能作用，废话不多扯了，开始正题：

1.找到mssql图标，右键属性：

2.点击打开文件位置-->SqlWorkbenchProjectItems-->Sql 如下图所示，其中包含了多个预设模板文件

3.打开Stored Procedure文件夹里面就是我们的存储过程预设模板文件

4.我们选择“Create Stored Procedure (New Menu).sql”打开，如下图

 

5.修改这一段，改成你想要的格式就行了，然后保存，就OK了（里面的创建存储过程的语法你都可以改变）。

 

例如我使用的模板代码如下：

-- =============================================
-- CopyRight:<Company Info>
-- Author:        <David>
-- Create date: <2020-09-01>
-- Description:    <Description>
-- Version: <v1.0>
-- =============================================

 

6.创建一个试试：

 ==============================================================

另附 Visual Studio中新建类时自动添加注释模板

修改 VS中新建类的模板

地址如下所示：D:\Program Files\Microsoft Visual Studio 12.0\Common7\IDE\ItemTemplatesCache\CSharp\Code\2052\Class

 

修改其中 Class.cs

在最顶上添加

/*-------------------------------------------------------------------------
 * 版权所有：XXX
 * 作者：XX
 * 联系方式：XXXXXXXX@qq.com
 * 创建时间： $time$
 * 版本号：v1.0
 * 本类主要用途描述：
 *  -------------------------------------------------------------------------*/