Skip to content
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.

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

SA1642 (constructor summary text) special case for structures #418

Closed
sharwell opened this issue Jan 26, 2015 · 4 comments · Fixed by #704
Closed

SA1642 (constructor summary text) special case for structures #418

sharwell opened this issue Jan 26, 2015 · 4 comments · Fixed by #704
Assignees
Milestone

Comments

@sharwell
Copy link
Member

Currently SA1642 always enforces the use of the word "class" in the documentation for constructors. Should the constructors for a struct type "prefer" the use of another word here, in the same sense as #413 handled the wording for private constructors?

@AArnott
Copy link
Contributor

AArnott commented Apr 22, 2015

Yes. "struct' should be the last word of the mandatory leading text for structure constructors.

@sharwell
Copy link
Member Author

@AArnott I guess the other question is should it be 'struct' or 'structure'?

@AArnott
Copy link
Contributor

AArnott commented Apr 22, 2015

struct.
My answers are based on the behavior of the original StyleCop. I have several very large codebases that are migrating from stylecop to stylecop.analyzers, and I'd love for it to go smoothly.
Also, I've noticed that a lot of the text StyleCop rules require to appear in xml doc comments to match MSDN docs, which I think has value to preserve as well.

@sharwell sharwell assigned sharwell and unassigned pdelvo Apr 24, 2015
@sharwell sharwell added this to the 1.0.0 Alpha 5 milestone Apr 24, 2015
@sharwell
Copy link
Member Author

I have several very large codebases that are migrating from stylecop to stylecop.analyzers

BTW, just saw this part. That's pretty cool! 👯

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants