應(yīng)用場景介紹

在我們使用一些開源項目時，基本上都會在每個源代碼文件的頭部看到一段版權(quán)聲明。一個項目或解決方案中源代碼文件的個數(shù)少則幾十，多則幾千甚至更多，那么怎么才能給這么多文件方便地批量添加或者修改一致的文件頭呢？在 2020 年 8 月 11 日 更新的?Visual Studio 2019?v16.7.1?版中，就加入了使用 EditorConfig 向現(xiàn)有文件、項目和解決方案添加文件頭?這一功能。提到?EditorConfig， 那么：

什么是 EditorConfig？

EditorConfig?是幫助跨多個編輯器和 IDE 的從事同一項目的多個開發(fā)人員保持一致性編碼風格的一個文本文件。EditorConfig 文件可以設(shè)置諸如縮進樣式、選項卡寬度、行尾字符以及編碼等，而無需考慮使用的編輯器或 IDE。向項目添加 EditorConfig 文件，可以強制對使用該項目的所有人員實施一致的編碼風格。EditorConfig 設(shè)置優(yōu)先于全局 Visual Studio 文本編輯器設(shè)置。

由于這些設(shè)置包含在基本代碼的文件中，因此能與基本代碼一起移動。只要在 EditorConfig 兼容的編輯器中打開代碼文件，就能實現(xiàn)文本編輯器設(shè)置。有關(guān) EditorConfig 文件的詳細信息，請參閱 EditorConfig.org(https://editorconfig.org/) 網(wǎng)站。

使用 Visual Studio 2019 添加文件頭

首先，在 Visual Studio 中打開項目或解決方案，點擊“幫助” > “關(guān)于”，查看您的 Visual Studio 2019 版本是否是?16.7.1?或更高版本，如果不是請先升級。

向項目或解決方案添加 EditorConfig。

根據(jù)要應(yīng)用?.editorconfig?設(shè)置的對象（是解決方案中的所有項目還是其中一個項目），選擇項目或解決方案節(jié)點。還可在項目或解決方案中選擇一個文件夾，向其添加?.editorconfig?文件。

從菜單欄中，選擇“項目” > “添加新項”，或按 Ctrl+Shift+A ：

或者在“解決方案資源管理器”中右鍵單擊項目、解決方案或文件夾，選擇“添加” > “新建 EditorConfig”：

添加完成后可以看到?.editorconfig?文件的內(nèi)容大致如下：

在?.editorconfig?文件中添加?file_header_template?項

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

.editorconfig?中換行需要使用 Unix 換行符(\n)來插入新行。

如圖：

將光標置于任意 C# 或 Visual Basic 文件的第一行，按?Ctrl+.?觸發(fā)“快速操作和重構(gòu)”菜單，選擇“添加文件頭”，如圖：

在“修復(fù)以下對象中的所有實例:”處可以選擇 “文檔”、“項目”或“解決方案”，下圖是選擇了“項目”后的預(yù)覽效果：

點擊“應(yīng)用”按鈕，以應(yīng)用更改。

此時可以看到項目中的所有代碼文件都添加了?.editorconfig?中設(shè)置的?file_header_template?項的字符串作為文件頭：

修改文件頭

修改文件頭和添加文件頭的步驟是一樣的。

在?.editorconfig?文件中修改?file_header_template?項的值

添加“技術(shù)譯站”幾個文字試試：

file_header_template = 添加文件頭（add file header）示例程序\n Copyright (c) 技術(shù)譯站 https://ittranslator.cn/

重復(fù)上面“添加文件頭”的第 3 步，預(yù)覽如下圖：

重復(fù)上面“添加文件頭”的第 4 步，點擊“應(yīng)用”按鈕，結(jié)果如下圖：

參考文獻

• https://docs.microsoft.com/zh-cn/visualstudio/ide/create-portable-custom-editor-options?view=vs-2019

• https://docs.microsoft.com/zh-cn/visualstudio/ide/reference/add-file-header?view=vs-2019

作者 ：技術(shù)譯民??
出品 ：技術(shù)譯站（https://ittranslator.cn/）

END

總結(jié)

以上是生活随笔為你收集整理的使用 Visual Studio 2019 批量添加代码文件头的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。