在 Visual Studio 中規範化文件編輯

来源:https://www.cnblogs.com/txrock/archive/2023/07/19/17566225.html
-Advertisement-
Play Games

## 簡介 ##### IoC Ioc控制反轉,是一種設計模式和原則,旨在解耦組件之間的依賴關係,並將對象的創建和管理委托外部容器。是面向編程中一種重要的概念,用於提高代碼的可維護性. 核心思想:通過將控制權從高層轉移到底層模塊,實現對依賴關係的控制反轉,傳統上,一個對象通常負責自己的依賴項創建和管 ...


代碼中常會出現縮進空格數量不規範、多餘空格等問題。為解決這一痛點,研發模板項目中引入了文件編輯器的配置文件,來規範化管理所有在編輯器中進行編輯的文件的格式、樣式、編碼約定等。

1 配置文件存放

生成了對應的 .editorconfig 文件,存放在倉儲的根目錄。即對整個倉儲所有的用 VS 作為 IDE 編輯的項目生效。

同時支持子目錄有自己的 .editorconfig 文件,可以選擇繼承更高級別父目錄的配置,也可以不繼承。

該文件將應用到模板項目當中。除非特殊情況需根據項目定製編碼規範,否則一般不予以任何變動。

具體使用哪些配置項和值,會在研發過程中不斷迭代演進,會有不同版本的 .editorconfig 定版,目前已發佈 1.0 版本。

2 VS 中如何應用

2.1 查看

2.1.1 錯誤列表

2.1.2 Intellisense 顯示在代碼中(不同顏色和形狀的下劃線)

  • 灰色點虛線(suggestion 建議/消息)
  • 綠色波浪線(warning 警告)
  • 紅色波浪線(error 錯誤)

2.2 單個文件

除了自行通過 Intellisense 和錯誤列表提示來進行代碼規範修複。還可以對單個文件執行一鍵代碼清理。

  1. 點擊配置代碼清理

  1. 使用 Shift 全選,配合上下箭頭,將【修複 EditorConfig 中設置的所有警告和錯誤】選到【包括的修複程式】中,其餘項可留在【可用的修複程式】中。

  1. 配置完成後,點擊小掃把按鈕【運行代碼清理(配置文件 1)】,即按照代碼規範完成對不規範代碼的調整(除一些無法自動調整的代碼,需根據錯誤列表手動解決)。運行代碼清理的快捷鍵為 Ctrl+K,Ctrl+E

2.3 整個解決方案或單個項目

  • 針對整個解決方案的清理,可以在分析菜單,或解決方案右鍵菜單中找到,但由於速度較慢不推薦使用。
  • 針對某個項目的清理,可以項目右鍵菜單中找到,可以根據項目規模酌情使用,較大規模的項目由於速度較慢不推薦使用。

3 參考資料

3.1 Visual Studio Editing

3.2 Coding Analysis and Coding Style


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • **本文詳細解析了Python的logging模塊,從基本介紹到實際應用和最佳實踐。我們通過具體的代碼示例解釋瞭如何高效地使用這個模塊進行日誌記錄,以及如何避免常見的陷阱,旨在幫助讀者更好地掌握這個強大的工具。** ![file](https://img2023.cnblogs.com/other/ ...
  • # Spring6 初始 @[toc] ## 每博一文案: ```tex 人生的態度是:抱有最大的希望。 盡最大的努力,做最壞的打算。 —————— 柏拉圖《理想國》 ``` ## 1. 初始 Spring6 閱讀以下代碼: ```java package com.powernode.oa.cont ...
  • 這篇文章主要記錄了本次遇到的問題:即maven在面對不同版本的jar包在pom文件中同時聲明會存在載入覆蓋的問題,於是通過查詢網上相關資料對maven包的載入規則介紹,並通過實際場景對其進行分析驗證 ...
  • # 1.模塊 ``` import 模塊名 ``` ## 1.1 模塊就是程式 任何python程式都可以作為模塊導入,並標明程式(模塊)的位置 ``` import sys sys.path.append('路徑') ``` ``` import hello // 在同一文件夾下 ``` 會在該文 ...
  • [toc] # 引入 - Microsoft.EntityFrameworkCore - Microsoft.EntityFrameworkCore.Design - Microsoft.EntityFrameworkCore.SqlServer - Microsoft.EntityFramewor ...
  • # 一、日誌記錄 日誌記錄是什麼?簡單而言,就是通過一些方式記錄應用程式運行中的某一時刻的狀態,保留應用程式當時的信息。這對於我們進行應用程式的分析、審計以及維護有很大的作用。 作為程式員,我們恐怕誰也不敢保證我們開發的軟體應用一定不存在BUG,一定不會出現故障,而當故障出現的時候,日誌就是我們排查 ...
  • # 基於Avalonia 11.0.0+ReactiveUI 的跨平臺項目開發2-功能開發 ![image-20230718225201652](https://www.raokun.top/upload/2023/07/image-20230718225201652.png) **項目簡介**:目 ...
  • 在使用DevExpress的GridView的時候,我們為了方便,往往使用一些擴展函數,動態創建GridView列的編輯控制項對象,然後我們可以靈活的對內容進行編輯或者使用一些彈出的對話框窗體進行處理內容的錄入,本篇隨筆就是介紹這一主題:在DevExpress的GridView的列中,動態創建列的時候... ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...