Skip to content

Fixed the file extension syntax and grammar #248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 18, 2017
Merged

Fixed the file extension syntax and grammar #248

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f63fe64
Fixed the file extension syntax and grammar
Aug 18, 2017
620308f
fixed comment in naming convention
Aug 18, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 29 additions & 29 deletions docs/ide/editorconfig-code-style-settings-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ For code style option, you must specify **true** (prefer this option) or **false

Severity | effect
------------ | -------------
none/silent | Do not show anything to the user when this style is not being followed, however code generation features will generate in this style.
none/silent | Do not show anything to the user when this style is not being followed, however code generation features generate in this style.
suggestion | When this style is not being followed, show it to the user as a suggestion (underlying dots on the first two characters).
warning | When this style is not being followed, show a compiler warning.
error | When this style is not being followed, show a compiler error.
Expand Down Expand Up @@ -111,8 +111,8 @@ error | When this style is not being followed, show a compiler error.

#### Example editorconfig file:
```
# CSharp and VisualBasic code style settings:
[*.cs,*.vb]
# CSharp and Visual Basic code style settings:
[*.{cs,vb}]
dotnet_style_qualification_for_field = false:suggestion
```

Expand All @@ -129,8 +129,8 @@ dotnet_style_qualification_for_field = false:suggestion

#### Example editorconfig file:
```
# CSharp and VisualBasic code style settings:
[*.cs,*.vb]
# CSharp and Visual Basic code style settings:
[*.{cs,vb}]
dotnet_style_qualification_for_property = false:suggestion
```

Expand All @@ -148,8 +148,8 @@ dotnet_style_qualification_for_property = false:suggestion

#### Example editorconfig file:
```
# CSharp and VisualBasic code style settings:
[*.cs, *.vb]
# CSharp and Visual Basic code style settings:
[*.{cs,vb}]
dotnet_style_qualification_for_method = false:suggestion
```

Expand All @@ -166,8 +166,8 @@ dotnet_style_qualification_for_method = false:suggestion

#### Example editorconfig file:
```
# CSharp and VisualBasic code style settings:
[*.cs, *.vb]
# CSharp and Visual Basic code style settings:
[*.{cs,vb}]
dotnet_style_qualification_for_event = false:suggestion
```

Expand All @@ -185,8 +185,8 @@ dotnet_style_qualification_for_event = false:suggestion

#### Example editorconfig file:
```
# CSharp and VisualBasic code style settings:
[*.cs, *.vb]
# CSharp and Visual Basic code style settings:
[*.{cs,vb}]
dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion
```

Expand All @@ -203,8 +203,8 @@ dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion

#### Example editorconfig file:
```
# CSharp and VisualBasic code style settings:
[*.cs, *.vb]
# CSharp and Visual Basic code style settings:
[*.{cs,vb}]
dotnet_style_predefined_type_for_member_access = true:suggestion
```

Expand All @@ -222,8 +222,8 @@ dotnet_style_predefined_type_for_member_access = true:suggestion

#### Example editorconfig file:
```
# CSharp and VisualBasic code style settings:
[*.cs, *.vb]
# CSharp and Visual Basic code style settings:
[*.{cs,vb}]
dotnet_style_object_initializer = true:suggestion
```

Expand All @@ -240,8 +240,8 @@ dotnet_style_object_initializer = true:suggestion

#### Example editorconfig file:
```
# CSharp and VisualBasic code style settings:
[*.cs, *.vb]
# CSharp and Visual Basic code style settings:
[*.{cs,vb}]
dotnet_style_collection_initializer = true:suggestion
```

Expand All @@ -258,8 +258,8 @@ dotnet_style_collection_initializer = true:suggestion

#### Example editorconfig file:
```
# CSharp and VisualBasic code style settings:
[*.cs, *.vb]
# CSharp and Visual Basic code style settings:
[*.{cs,vb}]
dotnet_style_explicit_tuple_names = true:suggestion
```

Expand All @@ -276,8 +276,8 @@ dotnet_style_explicit_tuple_names = true:suggestion

#### Example editorconfig file:
```
# CSharp and VisualBasic code style settings:
[*.cs, *.vb]
# CSharp and Visual Basic code style settings:
[*.{cs,vb}]
dotnet_style_coalesce_expression = true:suggestion
```

Expand All @@ -294,8 +294,8 @@ dotnet_style_coalesce_expression = true:suggestion

#### Example editorconfig file:
```
# CSharp and VisualBasic code style settings:
[*.cs, *.vb]
# CSharp and Visual Basic code style settings:
[*.{cs,vb}]
dotnet_style_null_propagation = true:suggestion
```

Expand Down Expand Up @@ -643,7 +643,7 @@ For formatting options, you must specify **true** (prefer this option) or **fals
#### Example editorconfig file:
```
# .NET formatting settings:
[*.cs, *.vb]
[*.{cs,vb}]
dotnet_sort_system_directives_first = true
```

Expand Down Expand Up @@ -1228,19 +1228,19 @@ styleTitle:<br>
`dotnet_naming_style.<styleTitle>.word_separator = string`<br>

## Writing a Naming Convention
For naming conventions, you must specify **symbols**, **style**, and a **severity**. Naming conventions should be ordered from most-specific to least-specific. The first rule encountered that can be applied, will be the only rule applied.
For naming conventions, you must specify **symbols**, **style**, and a **severity**. Naming conventions should be ordered from most-specific to least-specific. The first rule encountered that can be applied, is the only rule applied.

### Severity
The following are valid options for the severity of a naming style rule
`none`, `silent`, `suggestion`, `warning`, `error`.

`none` and `silent` are synonymous and mean that no indication of any kind should be shown to the user. This has the effect of disabling this rule.

`suggestion` means that the user will be shown the following in the Error List: and the following in the IDE. The `suggestion` severity will allow the naming rule to run, but it will not cause the build to break.
`suggestion` means that the user is shown the following in the Error List: and the following in the IDE. The `suggestion` severity allows the naming rule to run, but it doesn't cause the build to break.

Severity | effect
------------ | -------------
none/silent | Do not show anything to the user when this style is not being followed, however code generation features will generate in this style.
none/silent | Do not show anything to the user when this style is not being followed, however code generation features generate in this style.
suggestion | When this style is not being followed, show it to the user as a suggestion (underlying dots on the first two characters).
warning | When this style is not being followed, show a compiler warning.
error | When this style is not being followed, show a compiler error.
Expand Down Expand Up @@ -1289,8 +1289,8 @@ Identify the naming style to apply to the symbols.

### Example Naming Convention
```
# CSharp formatting settings:
[*.cs]
# Dotnet Naming Conventions
[*.{cs,vb}]
dotnet_naming_rule.async_methods_end_in_async.symbols = any_async_methods
dotnet_naming_rule.async_methods_end_in_async.style = end_in_async
dotnet_naming_rule.async_methods_end_in_async.severity = suggestion
Expand Down