Skip to content

Add reason for using primary constructor #50741

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

Open
gewarren wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add reason for using primary constructor #50741

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions docs/fundamentals/code-analysis/style-rules/ide0290.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ dev_langs:

This rule flags classes that can use a [primary constructor](../../../csharp/programming-guide/classes-and-structs/instance-constructors.md#primary-constructors) instead of a separate constructor definition. You define a primary constructor by placing any constructor parameters in parentheses following the type name. A primary constructor indicates that these parameters are necessary for any instance of the type.

The ability of a class or struct in C# to have more than one constructor provides for generality, but at the expense of some tedium in the declaration syntax, because the constructor input and the class state need to be cleanly separated. Primary constructors put the parameters of one constructor in scope for the whole class or struct to be used for initialization or directly as object state. The trade-off is that any other constructors must call through the primary constructor.
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The paragraph uses passive voice ("provides for generality") and complex phrasing that doesn't follow the conversational, active voice style required by the documentation guidelines. The text should be rewritten in active voice with simpler, more direct language. Consider rephrasing to use "you" and present tense with a conversational tone.

Copilot generated this review using guidance from repository custom instructions.
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to the Markdown writing style guidelines, complex sentences should be broken up for clarity. This sentence contains multiple clauses that make it difficult to scan and understand. Break this into shorter, clearer sentences.

Copilot generated this review using guidance from repository custom instructions.
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The phrase "need to be cleanly separated" is imprecise and doesn't follow the guideline to use specific, concrete language. What does "cleanly separated" mean in this context? Use more precise technical terminology.

Copilot generated this review using guidance from repository custom instructions.

## Options

Options specify the behavior that you want the rule to enforce. For information about configuring options, see [Option format](language-rules.md#option-format).
Expand Down
Loading