Voorkeuren voor codestijl
U kunt instellingen voor codestijlen per project definiëren met behulp van een EditorConfig-bestand, of voor alle code die u in Visual Studio bewerkt op de pagina Opties. Voor C#-code kunt u Visual Studio ook configureren om deze voorkeuren voor codestijlen toe te passen met behulp van de opdrachten Code Cleanup (Visual Studio 2019, Visual Studio 2022) en Document (Visual Studio 2017) opmaken.
Codestijlen in EditorConfig-bestanden
instellingen voor de codestijl voor .NET kunnen worden opgegeven door een EditorConfig--bestand toe te voegen aan uw project. EditorConfig-bestanden zijn gekoppeld aan een codebasis in plaats van een Visual Studio-personalisatieaccount. Instellingen in een EditorConfig-bestand hebben voorrang op codestijlen die zijn opgegeven in het dialoogvenster Opties. Gebruik een EditorConfig-bestand als u coderingsstijlen wilt afdwingen voor alle inzenders in uw opslagplaats of project.
U kunt het EditorConfig-bestand handmatig vullen of u kunt het bestand automatisch genereren op basis van de instellingen voor de codestijl die u hebt gekozen in het dialoogvenster Opties voor Visual Studio Opties. Deze optiepaginainstellingen zijn beschikbaar in Extra>Opties>Teksteditor> [C# of Basic] >Codestijl>Algemeen. Klik op .editorconfig-bestand genereren op basis van instellingen om automatisch een coderingsstijl te genereren .editorconfig bestand op basis van de instellingen op deze pagina Opties.
U kunt het EditorConfig-bestand handmatig vullen of u kunt het bestand automatisch genereren op basis van de instellingen voor de codestijl die u hebt gekozen in het dialoogvenster Opties voor Visual Studio Opties. Deze optiespagina is beschikbaar onder Extra>Opties>Teksteditor> [C# of Visual Basic] >Codestijl>Algemeen. Klik op .editorconfig-bestand genereren op basis van instellingen om automatisch een coderingsstijl te genereren .editorconfig bestand op basis van de instellingen op deze pagina Opties.
Codestijlen in het dialoogvenster Opties
Voorkeuren voor codestijlen kunnen worden ingesteld voor al uw C#- en Visual Basic-projecten door het dialoogvenster Opties te openen in het menu Extra. Selecteer in het dialoogvenster Opties de optie Teksteditor> [C# of Visual Basic] >Codestijl>Algemeen.
Voorkeuren voor codestijlen kunnen worden ingesteld voor al uw C#- en Visual Basic-projecten door het dialoogvenster Opties te openen in het menu Extra. In het dialoogvenster Opties, selecteer Teksteditor> [C# of Basic] >Codestijl>Algemeen.
Elk item in de lijst toont een voorbeeld van de voorkeur wanneer deze is geselecteerd:
Opties die in dit venster zijn ingesteld, zijn van toepassing op uw Visual Studio-personalisatieaccount en zijn niet gekoppeld aan een bepaald project of codebasis. Bovendien worden ze niet afgedwongen tijdens het buildproces, inclusief in continue integratie-builds. Als u voorkeuren voor codestijlen wilt koppelen aan uw project en de stijlen wilt laten afdwingen tijdens de build, geeft u de voorkeuren op in een .editorconfig-bestand dat aan het project is gekoppeld.
Voorkeur en ernst
Voor elke instelling van de codestijl op deze pagina kunt u de Voorkeur en Ernst waarden instellen met behulp van de vervolgkeuzelijsten op elke regel. Ernst kan worden ingesteld op Alleen herstructureren, Suggestie, Waarschuwingof Fout. Als u Snelle acties wilt inschakelen voor een codestijl, moet u ervoor zorgen dat de instelling Ernst is ingesteld op iets anders dan Alleenherstructureren. De Snelle Acties gloeilamp 
, waarschuwingslamp 
of schroevendraaier 
pictogram wordt weergegeven wanneer een niet-voorkeursstijl wordt gebruikt, en u kunt een optie kiezen in de Snelle Acties lijst om automatisch code te herschrijven naar de voorkeursstijl.
Codestijlen afdwingen bij het bouwen
Vanaf Visual Studio 2019 versie 16.8, die de .NET 5.0 RC2 SDK bevat, kunt u de .NET-coderingsconventies afdwingen bij het bouwen van voor alle .NET-projecten. Tijdens de build worden schendingen van de .NET-codestijl weergegeven als waarschuwingen of fouten met een IDE-voorvoegsel. Hiermee kunt u strikt consistente codestijlen afdwingen in uw codebasis.
Codestijlen toepassen
Voor C#-codebestanden heeft Visual Studio een knop Code opruimen onder aan de editor (toetsenbord: Ctrl+K, Ctrl+E) om codestijlen toe te passen vanuit een EditorConfig-bestand of op de pagina Codestijl opties. Als er een .editorconfig- bestand voor het project bestaat, zijn dit de instellingen die voorrang hebben.
Advies
Regels die zijn geconfigureerd met een ernst van Geen nemen niet deel aan het opschonen van code, maar kunnen en afzonderlijk worden toegepast via het menu Snelle Acties en Herschikkingen.
Om codestijlen toe te passen:
Configureer eerst welke codestijlen u wilt toepassen (in een van twee profielen) in het dialoogvenster Codeopruiming configureren. Als u dit dialoogvenster wilt openen, klikt u op de uitvouwpijl naast het bezempictogram voor het opschonen van code en kiest u vervolgens Codeopruiming configureren.
Nadat u het opschonen van code hebt geconfigureerd, gebruikt u een van de volgende methoden om codeopruiming uit te voeren:
Klik op het bezempictogram of druk op Ctrl+K, Ctrl+E om codeopruiming uit te voeren.
Als u het opschonen van code in uw hele project of oplossing wilt uitvoeren, klikt u met de rechtermuisknop op de naam van het project of de oplossing in Solution Explorer, selecteert u Analyseren en codeopruimenen selecteert u vervolgens Codeopruiming uitvoeren.
Als u wilt dat de instellingen voor de codestijl worden toegepast telkens wanneer u een bestand opslaat, kunt u de extensie Code opruimen bij Opslaan leuk vinden.
Voor C#-codebestanden heeft Visual Studio een knop Code opruimen onder aan de editor (toetsenbord: Ctrl+K, Ctrl+E) om codestijlen toe te passen vanuit een EditorConfig-bestand of op de pagina Codestijl opties. Als er een .editorconfig- bestand voor het project bestaat, zijn dit de instellingen die voorrang hebben.
Advies
Regels die zijn geconfigureerd met een ernst van Geen nemen niet deel aan het opschonen van code, maar kunnen en afzonderlijk worden toegepast via het menu Snelle Acties en Herschikkingen.
Om codestijlen toe te passen:
Configureer eerst welke codestijlen u wilt toepassen (in een van twee profielen) in het dialoogvenster Codeopruiming configureren. Als u dit dialoogvenster wilt openen, klikt u op de uitvouwpijl naast het bezempictogram voor het opschonen van code en kiest u vervolgens Codeopruiming configureren.
Nadat u het opschonen van code hebt geconfigureerd, gebruikt u een van de volgende methoden om codeopruiming uit te voeren:
Klik op het bezempictogram of druk op Ctrl+K, Ctrl+E-.
Als u het opschonen van code in uw hele project of oplossing wilt uitvoeren, klikt u met de rechtermuisknop op de naam van het project of de oplossing in Solution Explorer, selecteert u Analyseren en codeopruimenen selecteert u vervolgens Codeopruiming uitvoeren.
Als u de instellingen voor de codestijl wilt toepassen telkens wanneer u een bestand opslaat, gaat u naar Opties>Text Editor>Code Cleanup en selecteert u Code cleanup-profiel uitvoeren bij opslaan.
Instellingen voor het opschonen van code
De meeste instellingen voor het opschonen van code zijn toegewezen aan een of meer .NET-codestijlen die worden ondersteund in .editorconfig. Gebruik de koppelingen in de volgende tabel voor voorbeelden waarin de effecten van de instellingen worden weergegeven.
| Instelling | Regel-ID of stijloptie |
|---|---|
| Overbodige import- of gebruiksbewerkingen verwijderen | IDE0005 |
| Import- of gebruiksbewerkingen sorteren |
dotnet_sort_system_directives_first dotnet_separate_import_directive_groups |
| Voorkeuren voor bestandskoptekst toepassen | file_header_template |
| Ongebruikte variabelen verwijderen | CS0219 |
| Voorkeuren voor het maken van objecten toepassen | visual_basic_style_prefer_simplified_object_creation |
| IsNot-voorkeuren toepassen | visual_basic_style_prefer_isnot_expression (Voorkeur voor 'IsNot'-expressie in Visual Basic-stijl) |
| Kwalificatie 'this' of 'Me' toevoegen | IDE0003-IDE0009 |
| Toegankelijkheidsaanpassingen toevoegen | dotnet_style_require_accessibility_modifiers |
| Orderaanpassingen | IDE0036 |
| Veld alleen-lezen instellen | dotnet_style_readonly_field |
| Overbodige casts verwijderen | IDE0004 |
| Initialisatieparameters voor object/verzameling toepassen) | dotnet_style_object_initializer |
| Pas voorkeuren voor het gebruik van instructies toe | csharp_using_directive_placement |
| Voorkeuren voor haakjes toepassen | IDE0047-IDE0048 |
| Voorkeuren voor ongebruikte waarden toepassen | IDE0058 |
| Taal-/frameworktypevoorkeuren toepassen | IDE0049 |
| Ongebruikte onderdrukkingen verwijderen | dotnet_verwijder_onnodige_onderdrukking_uitsluitingen |
| Instellingen voor vereenvoudigen van Booleaanse expressies toepassen | dotnet_style_prefer_simplified_boolean_expressions |
| Voorkeuren voor tekenreeksinterpolatie toepassen | dotnet_style_prefer_simplified_interpolation |
| Ongebruikte parameters verwijderen | dotnet_code_quality_unused_parameters |
| Voorkeuren voor automatische eigenschappen toepassen | dotnet_style_prefer_auto_properties |
| Voorkeuren voor samengestelde toewijzing toepassen | dotnet_style_prefer_compound_assignment |
| Coalescentie-expressievoorkeuren toepassen | dotnet_style_coalesce_expression |
| Voorkeuren voor voorwaardelijke expressie toepassen |
dotnet_style_prefer_conditional_expression_over_assignment dotnet_style_prefer_conditional_expression_over_return |
| Voorkeuren voor tuplenaam toepassen |
dotnet_style_explicit_tuple_names dotnet_style_prefer_inferred_tuple_names |
| Voorkeuren voor afgeleide namen van anonieme typeleden toepassen | dotnet_style_prefer_inferred_anonymous_type_member_names |
| Voorkeuren voor null-controle toepassen | dotnet_style_prefer_is_null_check_over_reference_equality_method |
| Voorkeuren voor null-propagatie toepassen | dotnet_style_null_propagation |
| Var-voorkeuren toepassen | IDE0007-IDE0008 |
| Vereiste accolades toevoegen voor besturingsinstructies met één regel | csharp_prefer_braces |
| Voorkeuren voor expressies/bloktekst toepassen | leden met expressie-lichamen |
| Voorkeuren voor inline -outvariabelen toepassen | csharp_style_gedecentraliseerde_variabele_declaratie |
| Voorkeuren voor patroonherkenning toepassen | voorkeuren voor patroonkoppeling |
| Voorkeuren voor voorwaardelijke gedelegeerde aanroepen toepassen | csharp_style_conditional_delegate_call |
| Voorkeuren voor statische lokale functies toepassen | csharp_prefer_static_local_function |
| Deconstructvoorkeuren toepassen | csharp_style_deconstructed_variable_declaration |
| Standaardwaarde(T)-voorkeuren toepassen | csharp_prefer_simple_default_expression |
| Nieuwe() voorkeuren toepassen | csharp_style_implicit_object_creation_when_type_is_apparent |
| Voorkeuren voor bereik toepassen | csharp_style_prefer_range_operator |
| Geef de voorkeur aan lokale functies boven anonieme functies. | csharp_style_pattern_local_over_anonymous_function |
| Voorkeuren voor null-parameters toepassen | voorkeursinstellingen voor nulwaardecontrole |
| Toepassen met behulp van verklaringvoorkeuren | csharp_prefer_simple_using_statement |
| Voorkeurinstellingen voor throw-expressie toepassen | csharp_style_throw_expression |
::: moniker-end