Skip to content

Add guideline for trailing commas in initializers #467

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
Behnam-Emamian wants to merge 1 commit into
base: main
Choose a base branch
from
+1 −0
Open

Add guideline for trailing commas in initializers #467

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
1 change: 1 addition & 0 deletions instructions/csharp.instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ applyTo: '**/*.cs'
- Use pattern matching and switch expressions wherever possible.
- Use `nameof` instead of string literals when referring to member names.
- Ensure that XML doc comments are created for any public APIs. When applicable, include `<example>` and `<code>` documentation in the comments.
- Add a trailing comma after the last value in multi-line arrays, collection initializers, object initializers, and enum declarations to prevent MA0007 warnings.
Copy link
Contributor

@aaronpowell aaronpowell Dec 7, 2025

Choose a reason for hiding this comment

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

I'm unfamiliar with this warning - it does not appear to be part of the Roslyn analyser stack

Copy link
Author

@Behnam-Emamian Behnam-Emamian Dec 7, 2025

Choose a reason for hiding this comment

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

Correct, it is from another famous C# analyser, https://github.com/meziantou/Meziantou.Analyzer

https://github.com/meziantou/Meziantou.Analyzer/blob/main/docs/Rules/MA0007.md

Copy link
Contributor

@aaronpowell aaronpowell Dec 7, 2025

Choose a reason for hiding this comment

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

Ah ok. I'll admit to not being familiar with that analayzer stack.

Given that, I think this is a little overly specific for the generate C# instructions, especially as it's only one of the nearly 200 analyzer rules in that nuget package. I would suggest creating a dedicated instructions file that people can optionally layer in if they are using that analyzer too.

Copy link
Author

@Behnam-Emamian Behnam-Emamian Dec 7, 2025

Choose a reason for hiding this comment

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

what should be the name of the file of the instruction?

Copy link
Contributor

@aaronpowell aaronpowell Dec 8, 2025

Choose a reason for hiding this comment

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

meziantou-analuzer-rules.instructions.md would probably make sense


## Project Setup and Structure

Expand Down