Visual Studio自定义模板参数、备注

模板路径:

vbnet 复制代码
VS2022 x64:C:\Program Files\Microsoft Visual Studio\2022\Enterprise\Common7\IDE\ItemTemplates

VS2022 x86:C:\Program Files (x86)\Microsoft Visual Studio\2022\Enterprise\Common7\IDE\ItemTemplates

一、声明和启用模板参数

模板参数以 参数 的格式进行声明。 例如:

  • rootnamespace

  • guid1

  • guid5

二、在模板中启用参数替换

  1. 在模板的 .vstemplate 文件中,找到与要为之启用参数替换的项对应的 ProjectItem 元素。

  2. ReplaceParameters 元素的 ProjectItem 属性设置为 true

  3. 在项目项的代码文件中,在适当位置上包括参数。 例如,以下参数指定根命名空间用于文件中的命名空间:

    复制代码
    namespace $rootnamespace$

三、保留的模板参数

下表列出可供任何模板使用的保留的模板参数:

参数 说明
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 当前项目的根命名空间,后跟当前项的子文件夹,用句点替换斜杠。
defaultnamespace 当前项目的根命名空间。
safeitemname itemname 相同,但所有不安全字符和空格替换为了下划线。
safeitemrootname safeitemname 相同。
safeprojectname 用户在创建项目时提供的名称,但名称中删除了所有不安全字符和空格。 此参数仅适用于项目模板。
targetframeworkversion 目标 .NET Framework 的当前版本。
time 格式基于 Windows 用户设置的当前时间。 以 DD/MM/YYYY 00:00:00 时间格式为例。
specifiedsolutionname 解决方案的名称。 在选中"创建解决方案目录"时,specifiedsolutionname 具有解决方案名称。 在未选中"创建解决方案目录"时,specifiedsolutionname 为空。
userdomain 当前的用户域。
username 当前的用户名称。
webnamespace 当前网站的名称。 此参数在 Web 窗体模板中用于保证类名是唯一的。 如果网站在 Web 服务器的根目录下,则此模板参数解析为 Web 服务器的根目录。
year 以 YYYY 格式表示的当前年份。

备注:模板参数区分大小写。

说明来源地址:https://learn.microsoft.com/zh-cn/visualstudio/ide/template-parameters?view=vs-2022

四、示例

c#示例:

cs 复制代码
/*	CLR版本:			$clrversion$
*	新建项输入的名称:	$itemname$
*	机器名称:		    $machinename$
*	注册组织:		    $registeredorganization$
*	命名空间:		    $rootnamespace$
*	文件名:			    $safeitemrootname$
*	当前系统时间:		$time$	
*	用户所在域:		    $userdomain$
*	当前登录用户名:		$username$
*	创建年份:		    $year$
*	作者:SOESC
*/

VB.NET示例:

vbnet 复制代码
'***************************************************************************************************
'
' Copyright © $year$ SOESC.COM. All rights reserved.
'
' 文件名称(File Name) :$safeitemname$
'
' 命名空间(Namespaces) :$rootnamespace$
'
' 功能描述(Description) :无
'
' 数据表(Tables) :无
'
' 作者(Author) :无
'
' 日期(Create Date) :$time$
'
' 版本号(Version):V1.0.0.0
'
' 修改记录(Revision History) : 无
'
'
'***************************************************************************************************
相关推荐
learn_coder23 分钟前
在vscode中和obsidian中使用Mermaid
ide·vscode·编辑器
程序员的世界你不懂5 小时前
IDE 关联 Git 操作
ide·git
karry01306 小时前
高并发导致重复key问题--org.springframework.dao.DuplicateKeyException
java·数据库·ide
aramae18 小时前
C++ -- STL -- vector
开发语言·c++·笔记·后端·visual studio
蜕变的土豆1 天前
Visual Studio 旧版软件下载教程
ide·visual studio
金玉满堂@bj1 天前
PyCharm 中 Python 解释器的添加选项及作用
ide·python·pycharm
通信小小昕1 天前
ubuntu18.04.1无法安装vscode(安装依赖无效)
ide·vscode·编辑器
七月初七淮水竹亭~2 天前
Pycharm 报错 Environment location directory is not empty 如何解决
ide·python·pycharm
高hongyuan2 天前
Go语言教程-开发工具-Visual Studio
go·visual studio
green5+12 天前
yolo11n环境配置+实例运行【wsl+pycharm+conda】
ide·pycharm·conda