首页 > 其他分享 >在 Visual Studio 中规范化文件编辑

在 Visual Studio 中规范化文件编辑

时间:2023-07-19 17:22:09浏览次数:35  
标签:文件 配置文件 项目 代码 清理 Visual Studio 规范化

代码中常会出现缩进空格数量不规范、多余空格等问题。为解决这一痛点,研发模板项目中引入了文件编辑器的配置文件,来规范化管理所有在编辑器中进行编辑的文件的格式、样式、编码约定等。

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

标签:文件,配置文件,项目,代码,清理,Visual,Studio,规范化
From: https://www.cnblogs.com/txrock/p/17566225.html

相关文章

  • Java自带的jvisualVM简单介绍
    首先来介绍下visualVM的工作原理:VisualVM是一款Java虚拟机监控和分析工具,它可以帮助开发人员实时监控Java应用程序的性能和内存使用情况。VisualVM的工作原理是基于jJava虚拟机提供的JavaManagementExtensions(JMX)技术。JMX是一种Java平台的管理和监控技术,它......
  • CANoe执行vTESTstudio测试用例
    来源CANoe执行测试用例_哔哩哔哩_bilibili 打开对应的CANoe工程,在主菜单中选择Test 可以看到有TestUnits和TestModules,两者有什么区别呢?如果是CANoe创建测试节点编写的测试用例,需使用TestModules执行测试,若使用vTESTstudio编写的测试用例,则须使用TestUnits执行测试。1......
  • android studio自动换行
    AndroidStudio自动换行在AndroidStudio开发中,自动换行是一项非常方便的功能。它可以使代码更易读,减少水平滚动的需求,并且可以提高代码的可维护性。本文将介绍如何在AndroidStudio中使用自动换行功能,并提供一些代码示例来演示其用法。什么是自动换行?自动换行是指当一行代码长......
  • android studio统一管理jar
    AndroidStudio统一管理jar作为一名经验丰富的开发者,你需要教会新手开发者如何在AndroidStudio中统一管理jar文件。下面将详细介绍整个流程,包括每一步需要做的事情以及相应的代码。流程概述为了统一管理jar文件,我们将使用AndroidStudio的依赖管理工具Gradle。通过Gradle,我们可......
  • Power BI外挂级辅助工具 - DAX Studio 入门 第一篇(共两篇)
    今天早上又是美好的一天,进公司刚落座。隔壁部门的Tony哥直接杀了过来,“米高米高,我们组开发了一个PBI报告,但是现在有点小问题,帮我们看下怎么解决?”是否有方法非常灵活把PBI报告里面的基础数据导出成平面文件分享给其他同事?是否有方法非常方便的查询和验证PBI报告中的数据准确性?......
  • vTESTstudio工程创建
    来源vTESTstudio工程创建_哔哩哔哩_bilibili  打开vTESTstudio整个界面如下图所示 项目试图:显示项目的层级目录,包括创建的测试用例文件,测试参数文件Libraries库视图:可导入其它可复用的文件编辑区域:编辑测试用例及测试参数输出窗口:判断编译用例是否成功数据视图:导入工程......
  • Visual Studio 2022 .NET 7读取程序集版本
    如果你也像我一样是从.NetFramwork升级到.Net7版本,那大概率会碰到不能正常读取Assembly下的正确程序集版本号,利用asm.GetName().Version读到的是0.0.0.0,解决方法是新建一个项目,并将“AssemblyInfo.cs”复制到你的项目下Properties内。一些产品名称、公司信息等自行修改,Guid可......
  • 数据标注工具 Label-Studio
    文档抽取任务LabelStudio使用指南目录1.安装2.文档抽取任务标注2.1项目创建2.2数据上传2.3标签构建2.4任务标注2.5数据导出2.6数据转换2.7更多配置3.注意items["text"]=line["data"]["text"]Label-Studio导出数据后可通过label_studio.py脚本轻松......
  • Visual Studio 中,Release、Debug、x86和x64 四个不同的概念
    Release和Debug是编译的不同配置,用于控制编译器生成的代码和符号信息的方式。Release配置用于生成最终发布版本的代码。在Release模式下,编译器会进行各种优化,以提高程序的性能和执行效率。此外,Release模式下会禁用一些调试相关的功能,如断言和运行时错误检查。它适用于最......
  • 用android studio如何反编译
    使用AndroidStudio进行反编译在Android开发中,有时我们需要查看或修改其他应用的源代码,这就需要使用反编译工具来还原APK文件的Java源代码。AndroidStudio是一个功能强大的集成开发环境,它提供了反编译工具,可以帮助我们实现这一目的。问题背景假设我们想要查看某个应用的源代码,......