如何在Visual Studio 2017中自动添加项目详情至主程序代码
解决Visual Studio 2017社区版自动添加项目详情注释的问题
我来帮你搞定这个需求!你之前修改Class.cs没生效,大概率是模板路径找错了,或者没更新VS的模板缓存,下面是一步步的具体操作:
1. 找到正确的类模板文件路径
VS2017社区版的C#类模板默认位置是:
C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\ItemTemplates\CSharp\Code\1033\Class
- 注意
1033是英文模板的语言代码,如果你用的是中文版本VS,路径里的1033会变成2052 - 打开这个文件夹,里面的
Class.cs就是新建类时用的模板文件,需要以管理员权限打开它(不然可能无法保存修改)
2. 修改模板文件,添加自定义注释
打开Class.cs后,在所有using语句和namespace之间插入你需要的注释块,用VS自带的模板宏来自动填充动态内容:
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$ /****************************************** * 作者:$username$ * 创建日期:$time$ * 项目名称:$projectname$ ******************************************/ namespace $rootnamespace$ { class $safeitemrootname$ { } }
这里的宏说明:
$username$:自动替换为当前登录系统的用户名$time$:自动替换为文件创建的日期和时间$projectname$:自动替换为当前项目的名称
你可以根据自己的需求调整注释的格式,比如添加更多项目信息。
3. 更新VS模板缓存
修改完模板后,VS不会立刻识别到变化,需要刷新缓存:
- 关闭所有VS窗口
- 找到VS2017的“开发人员命令提示符”,右键选择以管理员身份运行
- 输入命令并回车:
devenv /installvstemplates
- 等待命令执行完成后,重新打开VS即可
备选方案:创建自定义模板(不修改系统模板)
如果你不想改动系统自带的模板,可以创建自己的自定义模板:
- 在VS中新建一个类,手动添加好你想要的注释格式
- 右键这个类文件,选择导出模板
- 按照向导完成导出,选择“项模板”,并填写模板名称和描述
- 之后新建项时,就能在“已安装”模板里看到你自己的模板,用它创建的类会自动带上注释
这样操作后,你新建类时就会自动在using和namespace之间生成包含作者、创建时间等信息的注释啦!
内容的提问来源于stack exchange,提问作者Matias
相关产品推荐
相关产品推荐

