Apply suggestion from @Copilot
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
parent
8a31584b82
commit
02f8e64fd4
@ -51,7 +51,7 @@ description: 'Ensure that C# types are documented with XML comments and follow b
|
|||||||
- "Gets [or sets] a value that indicates whether..." for properties that return a Boolean value.
|
- "Gets [or sets] a value that indicates whether..." for properties that return a Boolean value.
|
||||||
- Use `<value>` to describe the value of the property.
|
- Use `<value>` to describe the value of the property.
|
||||||
- The description should be a noun phrase that doesn't specify the data type.
|
- The description should be a noun phrase that doesn't specify the data type.
|
||||||
- If the property has a default value, add it in a separate sentence, for example, "The default is `<see langword="false" />`".
|
- If the property has a default value, add it in a separate sentence, for example, "The default is `<see langword="false" />`".
|
||||||
- If the value type is Boolean, the wording should be of the form "`<see langword="true" />` if ...; otherwise, `<see langword="false" />`. The default is ...".
|
- If the value type is Boolean, the wording should be of the form "`<see langword="true" />` if ...; otherwise, `<see langword="false" />`. The default is ...".
|
||||||
|
|
||||||
## Exceptions
|
## Exceptions
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user