Click or drag to resize

C# Options

This category contains several options that let you fine tune how C# source code files are spell checked. The following options are available. All of them are disabled by default so that the associated elements are included for spell checking. By enabling the last option, it is also possible to have these options applied to all C-style code as applicable.

  • Ignore XML documentation comments (/// ... and /** ... */) - If enabled, XML documentation comments will be excluded from spell checking. Unless disabled with the option below, standard delimited comments will still be included for spell checking.

  • Ignore delimited comments (/* ... */) - This is useful for excluding private comments that nobody will see except for developers and commented out code. Unless disabled with the option above, delimited XML comments will still be included for spell checking.

  • Ignore standard single line comments (// ...) - This is useful for excluding private comments that nobody will see except for developers and commented out code.

  • Ignore quadruple slash single line comments (//// ...) - This option is useful for ignoring commented out code using the method recommended by StyleCop so that it does not produce style warnings.

  • Ignore normal string literals ("...") - This is useful for ignoring string literals in code if you use resource files for localized text. In such cases, the string literals are usually not valid words and enabling this option prevents the resource keys from showing up as spelling errors.

  • Ignore verbatim string literals (@"...") - Verbatim string literals typically contain such things as filenames or multi-line text that is not usually considered text that needs to be spell checked. Enabling this option prevents their content from being checked for spelling errors.

  • Ignore interpolated string literals ($"{PropertyName}...") - This is useful for skipping interpolated strings which may only contain property format specifiers. Enabling this option prevents their content from being checked for spelling errors. If left disabled, all string content except text within braces which denote format specifiers will be spell checked.

  • Apply the above options to all C-style languages as applicable - If this option is enabled, the above options are applied to all C-style languages as applicable. For example, all of the comments options and the normal string literal option will be applied to C, C++, JavaScript, etc.

See Also

Other Resources