Skip to content

Commit

Permalink
Merge pull request #3697 from bjornhellander/feature/sa1308-doc
Browse files Browse the repository at this point in the history
Update documentation for SA1308 to also mention prefix "t_"
  • Loading branch information
sharwell committed Sep 18, 2023
2 parents 890236e + fce493b commit af76eb5
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions documentation/SA1308.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@

## Cause

A field name in C# is prefixed with *m_* or *s_*.
A field name in C# is prefixed with *m_*, *s_*, or *t_*.

## Rule description

A violation of this rule occurs when a field name is prefixed by *m_* or *s_*.
A violation of this rule occurs when a field name is prefixed by *m_*, *s_*, or *t_*.

By default, StyleCop disallows the use of underscores, *m_*, etc., to mark local class fields, in favor of the 'this.' prefix. The advantage of using 'this.' is that it applies equally to all element types including methods, properties, etc., and not just fields, making all calls to class members instantly recognizable, regardless of which editor is being used to view the code. Another advantage is that it creates a quick, recognizable differentiation between instance members and static members, which will not be prefixed.

Expand Down

0 comments on commit af76eb5

Please sign in to comment.