Microsoft Visual Studio新建文件自动添加注释

原创已于 2023-04-06 14:14:10 修改 · 2k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#microsoft #c#

于 2021-10-06 00:41:09 首次发布

C# 专栏收录该内容

3 篇文章

订阅专栏

本文介绍了如何在Visual Studio中自定义C#类文件的注释模板，通过编辑ItemTemplate文件，添加所需的注释内容，实现新建文件时自动包含特定的代码注释，提高开发效率。

当你用IDE-VS编写程序有一段时间时，会觉得其他人的每个文件中有注释，但手动添加感觉稍微有点重复劳动的，就想在程序生成的同时自动添加你需要的文字注释。

下面是具体方法，可以找到VS安装的路径：（本人VS2019为例）

D:\XXX\XX\Microsoft Visual Studio\2019\Professional\Common7\IDE\ItemTemplates\CSharp\Code\2052\Class.cs文件

如果找不到可以通过搜索神器Everything关键字为Class就可找到相应的文件。

在顶部输入你需要的注释，然后保存即可，就可以新建一个文件看看效果了。

/*
* 命名空间: $rootnamespace$
*
* 功 能： N/A
* 类 名： $safeitemname$
*
* Ver 变更日期 负责人 变更内容
* ───────────────────────────────────
* V0.01 $time$ xxx   初版
* Copyright (c) 2023 xxx Corporation. All rights reserved.
*┌──────────────────────────────────────────────────────────────┐
*│　此技术信息为本公司机密信息，未经本公司书面同意禁止向第三方披露．  │ 
*│　版权所有:有限公司.                                  　　      │                                         
*└──────────────────────────────────────────────────────────────┘
*/
using System;
using System.Collections.Generic;
$if$ ($targetframeworkversion$ >= 3.5)using System.Linq;
$endif$using System.Text;
$if$ ($targetframeworkversion$ >= 4.5)using System.Threading.Tasks;
$endif$
namespace $rootnamespace$
{
    class $safeitemrootname$
    {

    }
}