用Visual Studio2019自定义项目模板
项目模板简介
众所周知,在我们使用VS新建项目时,都需要选择一个项目模板,如下图:
我们选择完项目模板进行创建,创建完成之后,可以发现项目中已经包含了一些基础的文件。例如MVC:
可以看到,MVC项目下,这么多的文件、类都给我们自动生成了,我们并不需要敲任何代码。
所以,项目模板,就是在我们创建新项目界面中,给我们列出来的模板文件。
这些文件都是VS自带的,但在实际工作中,很多时候我们需要的是一个跟我们项目的业务更加契合的、可复用的项目模板,这时候就需要我们自己去创建一个自定义的项目模板了。
项目模板创建步骤
创建自定义的项目模板,有以下几个步骤:
- 创建一个原始的项目,我们称之为模板源;
- 替换模板参数
- 导出模板源项目, 给模板项目设置名称、说明、图标等内容
- 给项目模板添加语言、平台和项目类型等标签
- 使用自定义的项目模板
创建模板源项目
首先我们创建一个原始的项目。
以下是我创建的Demo,添加了几个文件,只是用来做一个简单的例子,实际开发中可能比这复杂的多。
模板中的参数
我们创建出来的模板源项目,有很多内容在创建项目之前是不确定的,比如命名空间、类名称等,这怎么办呢?
VS也给了我们解决办法,我们可以在源项目中,使用模板参数来代替这些不确定的信息,在实际创建项目时,VS会将这些模板参数替换为实际的内容。
以HomeController.cs文件为例,使用模板参数代替命名空间名称:
模板参数以 $参数$ 的格式进行声明 。$safeprojectname$
表示的
就是命名空间的模板参数。
VS完整的模板参数如下:
参数 | 描述 |
---|---|
clrversion | 公共语言运行时 (CLR) 的当前版本。 |
ext_* | 将 ext_ 前缀添加到任何参数,以引用父模板的变量。 例如 ext_safeprojectname。 |
guid[1-10] | 一个用于替换项目文件中的项目 GUID 的 GUID。 可指定最多 10 个唯一的 GUID(例如,guid1)。 |
itemname | 在其中使用参数的文件的名称。 |
machinename | 当前的计算机名称(例如,Computer01)。 |
projectname | 创建项目时由用户提供的名称。 |
registeredorganization | 来自 HKLM\Software\Microsoft\Windows NT\CurrentVersion\RegisteredOrganization 的注册表项值。 |
rootnamespace | 当前项目的根命名空间。 此参数仅适用于项模板。 |
safeitemname | 与 itemname 相同,但所有不安全字符和空格替换为了下划线。 |
safeitemrootname | 与 safeitemname 相同。 |
safeprojectname | 用户在创建项目时提供的名称,但名称中删除了所有不安全字符和空格。 |
time | 以 DD/MM/YYYY 00:00:00 格式表示的当前时间。 |
specifiedsolutionname | 解决方案的名称。 在选中“创建解决方案目录”时,specifiedsolutionname 具有解决方案名称。 在未选中“创建解决方案目录”时,specifiedsolutionname 为空。 |
userdomain | 当前的用户域。 |
username | 当前的用户名称。 |
webnamespace | 当前网站的名称。 此参数在 Web 窗体模板中用于保证类名是唯一的。 如果网站在 Web 服务器的根目录下,则此模板参数解析为 Web 服务器的根目录。 |
year | 以 YYYY 格式表示的当前年份。 |
除了VS自带的模板参数外,用户还可以自定义模板参数,但实际用到的不多,在此就不扩展赘述了。
导出模板
源文件中的模板参数替换好之后,我们就可以导出模板了,操作步骤如下:
打开工具栏中的项目->选择导出模板
弹出【导出模板向导】界面,选择项目模板即可,下方选择的是要导出的项目。
接下来,在模板选项中,填入模板的名称,说明,图标等信息:
注意这个输出位置,这是自定义项目模板存放的路径。
下面的【自动将模板导入 Visual Studio】选项,选中后会将项目模板复制一份,放入到特定的文件夹中,下次创建新项目就可以搜索到了。
点击完成,VS会把项目模板压缩为.zip文件,分别导入到以下两个文件夹中:C:\Users\Lenovo\Documents\Visual Studio 2019\My Exported Templates
C:\Users\Lenovo\Documents\Visual Studio 2019\Templates\ProjectTemplates
这时候不需要任何其他的操作,打开VS的启动窗口,点开创建新项目,就可以找到ProjectTemplateDemo
这个项目模板了。
下面使用这个模板创建一个项目
可以看到,项目的结构与我们项目模板一模一样,命名空间名称也被替换为Demo1
了。
给项目模板添加标签
其实到这一步,我们的项目模板就可以正常使用了,但我们会发现一个问题,我们的项目模板没有这样的标签:
虽然不影响使用,但当查找项目模板时,也不是很方便,所以我们需要给创建的项目模板添加几个对应的标签。方法如下:
首先打开这个模板导入到的文件夹,路径:C:\Users\Lenovo\Documents\Visual Studio 2019\Templates\ProjectTemplates
解压ProjectTemplateDemo
这个压缩包。
在解压好的ProjectTemplateDemo
文件夹里,用VS打开MyTemplate.vstemplate
这个文件。
这是一个XML文件,我们需要在TemplateData
标签里添加上项目使用语言、平台、项目类型的信息。
语言、平台、项目类型的标签分别为LanguageTag
、PlatformTag
、ProjectTypeTag
。
同时,Visual Studio 提供了一系列内置标签。以下列表是 Visual Studio 中可用的内置标签,对应的值显示在括号中。
语言标签 | 平台标签 | 项目类型标签 |
---|---|---|
C (cpp) | Android (android) | 云 (cloud) |
单元格 | 单元格 | 单元格 |
C# (csharp) | Azure (azure) | 控制台 (console) |
F# (fsharp) | iOS (ios) | 桌面 (desktop) |
Java (java) | Linux (linux) | 扩展 (extension) |
JavaScript (javascript) | macOS (macos) | 游戏 (games) |
Python (python) | tvOS (tvos) | IoT (iot) |
查询语言 (querylanguage) | Windows (windows) | 库 (library) |
TypeScript (typescript) | Xbox (xbox) | 机器学习 (machinelearning) |
Visual Basic (visualbasic) | 移动 (mobile) | |
Office (office) | ||
其他 (other) | ||
服务 (service) | ||
测试 (test) | ||
UWP (uwp) | ||
Web (web) |
我们修改这个文件,添加几个对应的标签:
我们把这个文件保存一下,保存之后,跳到文件夹下,全选文件,重新压缩一遍修改好的ProjectTemplateDemo
文件:
注意,压缩包必须是.zip文件。
压缩完成后,把这个压缩包拷贝到C:\Users\Lenovo\Documents\Visual Studio 2019\Templates\ProjectTemplates
目录下,并覆盖掉旧的压缩包。
然后删除解压后的文件。
这时候重新创建新项目,选择ProjectTemplateDemo
项目模板,可以看到我们的标签已经加上去了。
至此,就是自定义项目模板的全部步骤。
总结
自定义的项目模板作用非常大,在大型的项目中,如果使用好的话会大大提升我们的开发效率。
以上就是本文章的全部内容。更多内容可访问我的博客:http://www.yunc.top/
用Visual Studio2019自定义项目模板的更多相关文章
- [Visual Studio] 自定义项目模板(.vsix扩展)
VS自定义项目模板:[2]创建VSIX项目模板扩展 听语音 | 浏览:1237 | 更新:2015-01-02 09:21 | 标签:软件开发 1 2 3 4 5 6 7 分步阅读 一键约师傅 百度师 ...
- Visual Studio 自定义项目模板
经常我们需要新建一个项目,然后新建我们的View文件夹,ViewModel文件夹,Model文件夹,还有把我们的ViewModelBase放入我们的VIewModel,如果还用框架,还需要加上好多. ...
- 如何利用 Visual Studio 自定义项目或工程模板
在开发项目的时候,由其是商业性质的大型项目时,往往需要在每个代码文件上都加上一段关于版权.开发人员的信息,并且名称空间上都需要带有公司的标志.这个时候,是选择在开发的时候手动添加还是自动生成呢? 我们 ...
- VS自定义项目模板:[2]创建VSIX项目模板扩展
VS自定义项目模板:[2]创建VSIX项目模板扩展 听语音 | 浏览:1237 | 更新:2015-01-02 09:21 | 标签:软件开发 1 2 3 4 5 6 7 分步阅读 一键约师傅 百度师 ...
- DotNetBar for Windows Forms 12.9.0.0_冰河之刃重打包版及制作Visual Studio C#项目模板文件详解
关于 DotNetBar for Windows Forms 12.9.0.0_冰河之刃重打包版 --------------------11.8.0.8_冰河之刃重打包版-------------- ...
- Visual Studio 自定义项目或工程模板
如何利用 Visual Studio 自定义项目或工程模板 在开发项目的时候,由其是商业性质的大型项目时,往往需要在每个代码文件上都加上一段关于版权.开发人员的信息,并且名称空间上都需要带有公司的标志 ...
- 如何利用 Visual Studio 自定义项目或工程模板(转载)
在开发项目的时候,由其是商业性质的大型项目时,往往需要在每个代码文件上都加上一段关于版权.开发人员的信息,并且名称空间上都需要带有公司的标志.这个时候,是选择在开发的时候手动添加还是自动生成呢? 我们 ...
- VS2019 自定义项目模板
前言: 使用"宇宙最强IDE"开发项目时,都需要根据不同情况选择一个项目模板,来满足开发需求:如下 VS为我们提供了基础的项目模板,但现有项目模板未包含基础功能如:日志输出.审计日 ...
- .NET Core - 自定义项目模板
前言: 前面介绍 自定义项目模板 中介绍了一种简单的方式--通过创建项目导出为项目模板方式实现.本次将采用dotenet cil(手脚架)来创建项目模板. 那么,我们首先看下当前dotnet 支持的项 ...
随机推荐
- 【Java】Array 数组
概述 数组是多个相同数据类型按一定顺序排列的一组数据 特点: - 数据类型相同!! - 长度固定!! 构成数组的几个要素 - 数组名称 - 下标,又称索引 - 元素 - 数组长度 数组是一种引用类型, ...
- GeoGebra小制作
效果 文件链接https://www.geogebra.org/m/bkxrjymh
- python基础入门:matplotlib绘制多Y轴画图(附源码)
前言 本文的文字及图片来源于网络,仅供学习.交流使用,不具有任何商业用途,版权归原作者所有,如有问题请及时联系我们以作处理. 作者:屁屁酱 PS:如有需要Python学习资料的小伙伴可以加点击下方链接 ...
- C - Infinite Fence -1260C
考虑区间长度,我们让r和b除以他们的__gcd这样,这样得到的r和b是互质或者相等的.我们取他们两个小的那个.假设是b.那么被涂的方块应该是b,2b,3b,4b,....kb. 相邻的两个方块之间的区 ...
- gdb 调试中No symbol “***” in current context解决方法
主要是因为GCC/G++版本和GDB不匹配造成的,网上也有说是因为O2优化问题,具体啥原因需要自己尝试一下. 解决: 放狗搜索,解决办法是在编译是加-gdwarf-3即可,出现这样的原因是gcc,gd ...
- OkHttp 优雅封装 HttpUtils 之 气海雪山初探
曾经在代码里放荡不羁,如今在博文中日夜兼行,只为今天与你分享成果.如果觉得本文有用,记得关注我,我将带给你更多. 介绍 HttpUtils 是近期开源的对 OkHttp 轻量封装的框架,它独创的异步预 ...
- redis: Jedis API(十四)
1.Key操作 package com.kuang; import redis.clients.jedis.Jedis; import java.util.Set; public class Test ...
- Linux网络编程(1)
Preview 课程要求,所以学了一下UNIX网络编程,老师说挺简单的,实际上手之后才发现这里面关系没那么简单.从CS:APP11章网络编程,再加上不停地man,对当前的学习做个总结,也顺带当个报告了 ...
- ASP.NET Core Razor Pages 初探
最近新建 Asp.net Core MVC 项目的时候不小心选错了个模板,发现了一种新的项目模板.它使用cshtml视图模板,但是没有Controller文件夹.后来才发现这是ASP.NET Core ...
- DBeaver数据表的拷贝过程
通过DBeaver工具链接数据库后,我们就可以通过菜单或者命令功能来实现我们想要的目的. (一)创建数据库 新建数据库,如下图所示: ——> 在点击“确定”按钮后,可能会遇到失败,此时,我们可 ...