应用场景介绍

在我们使用一些开源项目时,基本上都会在每个源代码文件的头部看到一段版权声明。一个项目或解决方案中源代码文件的个数少则几十,多则几千甚至更多,那么怎么才能给这么多文件方便地批量添加或者修改一致的文件头呢?在 2020 年 8 月 11 日 更新的 Visual Studio 2019 v16.7.1 版中,就加入了使用 EditorConfig 向现有文件、项目和解决方案添加文件头 这一功能。提到 EditorConfig, 那么:

什么是 EditorConfig?

EditorConfig 是帮助跨多个编辑器和 IDE 的从事同一项目的多个开发人员保持一致性编码风格的一个文本文件。EditorConfig 文件可以设置诸如缩进样式、选项卡宽度、行尾字符以及编码等,而无需考虑使用的编辑器或 IDE。向项目添加 EditorConfig 文件,可以强制对使用该项目的所有人员实施一致的编码风格。 EditorConfig 设置优先于全局 Visual Studio 文本编辑器设置。

由于这些设置包含在基本代码的文件中,因此能与基本代码一起移动。 只要在 EditorConfig 兼容的编辑器中打开代码文件,就能实现文本编辑器设置。 有关 EditorConfig 文件的详细信息,请参阅 EditorConfig.org 网站。

使用 Visual Studio 2019 添加文件头

首先,在 Visual Studio 中打开项目或解决方案,点击“帮助” > “关于”,查看您的 Visual Studio 2019 版本是否是 16.7.1 或更高版本,如果不是请先升级。

  1. 向项目或解决方案添加 EditorConfig。

    根据要应用 .editorconfig 设置的对象(是解决方案中的所有项目还是其中一个项目),选择项目或解决方案节点。 还可在项目或解决方案中选择一个文件夹,向其添加 .editorconfig 文件。

    从菜单栏中,选择“项目” > “添加新项”,或按 Ctrl+Shift+A :

    或者在“解决方案资源管理器”中右键单击项目、解决方案或文件夹,选择“添加” > “新建 EditorConfig”:

    添加完成后可以看到 .editorconfig 文件的内容大致如下:

  2. .editorconfig 文件中添加 file_header_template

    file_header_template = 添加文件头(add file header)示例程序\n Copyright (c) https://ittranslator.cn/

    .editorconfig 中换行需要使用 Unix 换行符(\n)来插入新行。

    如图:

  3. 将光标置于任意 C# 或 Visual Basic 文件的第一行,按 Ctrl+. 触发“快速操作和重构”菜单,选择“添加文件头”,如图:

    在“修复以下对象中的所有实例:”处可以选择 “文档”、“项目”或“解决方案”,下图是选择了“项目”后的预览效果:

  4. 点击“应用”按钮,以应用更改。

    此时可以看到项目中的所有代码文件都添加了 .editorconfig 中设置的 file_header_template 项的字符串作为文件头:

修改文件头

修改文件头和添加文件头的步骤是一样的。

  1. .editorconfig 文件中修改 file_header_template 项的值

    添加“技术译站”几个文字试试:

    file_header_template = 添加文件头(add file header)示例程序\n Copyright (c) 技术译站 https://ittranslator.cn/
  2. 重复上面“添加文件头”的第 3 步,预览如下图:

  3. 重复上面“添加文件头”的第 4 步,点击“应用”按钮,结果如下图:

参考文献

作者 : 技术译民

出品 : 技术译站

使用 Visual Studio 2019 批量添加代码文件头的更多相关文章

  1. Visual Studio Code-批量添加或删除注释行

    小技巧一例,批量删除Visual Studio code或notepad++注解信息,便于读取有效代码或文本信息,具体操作如下: Visual Studio Code批量删除注解行信息: 在VS Co ...

  2. visual studio 2019工具里添加开发中命令提示符的方法

    最新新装了visual studio 2019,发现默认的没有开发者命令提示符 现将添加步骤描述如下: 从VS2019菜单选择"Tools",然后选择"外部工具" ...

  3. Visual Studio 2019 正式发布,重磅更新,支持live share

    如约而至,微软已于今天推出 Visual Studio 2019 正式版,一同发布的还有 Visual Studio 2019 for Mac. Visual Studio 2019 下载地址:htt ...

  4. “宇宙最强” IDE,Visual Studio 2019 正式发布

    转载请注明出处:葡萄城官网,葡萄城为开发者提供专业的开发工具.解决方案和服务,赋能开发者. 本文由葡萄城翻译并发布 今天凌晨Visual Studio 2019已经正式发布,现在已经可以下载了.使用V ...

  5. Visual Studio 2019 RC入门

    介绍 在本文中,让我们看看如何开始使用Visual Studio 2019 RC.Microsoft现已发布Visual Studio Release Candidate,现在可以下载了.最初,Mic ...

  6. ComponentOne 2019V1:全面支持 Visual Studio 2019

    ComponentOne Enterprise 2019V1已经正式发布,本次更新的最大亮点就是 ComponentOne 控件全面支持 Visual Studio 2019. 作为一款专注于企业应用 ...

  7. [翻译] Visual Studio 2019: 极速编码. 智能工作. 创造未来.

    原文: Visual Studio 2019: Code faster. Work smarter. Create the future. Visual Studio 2019 的正式版现在可以下载了 ...

  8. [翻译] Visual Studio 2019 RC版发布

    [翻译] Visual Studio 2019 RC版发布 原文: Visual Studio 2019 Release Candidate (RC) now available 今天,我们将分享 V ...

  9. 【转载】“宇宙最强” IDE,Visual Studio 2019 正式发布

    转载请注明出处:葡萄城官网,葡萄城为开发者提供专业的开发工具.解决方案和服务,赋能开发者. 本文由葡萄城翻译并发布 今天凌晨Visual Studio 2019已经正式发布,现在已经可以下载了.使用V ...

随机推荐

  1. P4463 [集训队互测2012] calc 拉格朗日插值 dp 多项式分析

    LINK:calc 容易得到一个nk的dp做法 同时发现走不通了 此时可以考虑暴力生成函数. 不过化简那套不太熟 且最后需要求多项式幂级数及多项式exp等难写的东西. 这里考虑观察优化dp的做法. 不 ...

  2. rabbitMQ安装问题记录

    参考链接: rabbitmq国内镜像地址:https://www.newbe.pro/Mirrors/Mirrors-RabbitMQ/ https://www.zhihu.com/question/ ...

  3. 037_go语言中的互斥锁

    代码演示: package main import ( "fmt" "math/rand" "runtime" "sync&quo ...

  4. Python分析「我们为什么这么穷」

  5. JDBC回顾

    回顾JDBC,完成查询 1 什么是JDBC JDBC(Java DataBase Connectivity)就是Java数据库连接,说白了就是用Java语言来操作数据库.原来我们操作数据库是在控制台使 ...

  6. Vue组件通信之父传子

    一般情况下,子组件中无法直接使用父组件的变量.借助子组件的props选项可以实现这一点. 这里我将一个vue实例作为一个父组件: const app = new Vue({ el:'#div1', d ...

  7. C#LeetCode刷题之#326-3的幂(Power of Three)

    问题 该文章的最新版本已迁移至个人博客[比特飞],单击链接 https://www.byteflying.com/archives/3867 访问. 给定一个整数,写一个函数来判断它是否是 3 的幂次 ...

  8. C#LeetCode刷题之#136-只出现一次的数字(Single Number)

    问题 该文章的最新版本已迁移至个人博客[比特飞],单击链接 https://www.byteflying.com/archives/4046 访问. 给定一个非空整数数组,除了某个元素只出现一次以外, ...

  9. TD课程通的使用体验

    这个软件一点进去便是石家庄铁道大学,但是那张图片可以尽量的缩小一点比例,可以选择部分,至少能够让人了解到这是什么,另外,可以添加注册功能,或者是使用学号什么的来登录,亦或者手机号码等,整体的展示效果还 ...

  10. 洛谷P1036.选数(DFS)

    题目描述 已知 n个整数 x1,x2,-,xn,以及11个整数k(k<n).从n个整数中任选k个整数相加,可分别得到一系列的和.例如当n=4,k=3,4个整数分别为3,7,12,19时,可得全部 ...