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

Style: Error SA1514 Element documentation header should be preceded by blank line #28187

Closed
donhuvy opened this issue Jun 8, 2022 · 2 comments · Fixed by #28549
Closed

Style: Error SA1514 Element documentation header should be preceded by blank line #28187

donhuvy opened this issue Jun 8, 2022 · 2 comments · Fixed by #28549
Assignees
Labels
area-scaffolding closed-fixed The issue has been fixed and is/will be included in the release indicated by the issue milestone. customer-reported type-bug
Milestone

Comments

@donhuvy
Copy link

donhuvy commented Jun 8, 2022

.NET 6.0.300

dotnet add package Microsoft.EntityFrameworkCore.Design

dotnet add package Microsoft.EntityFrameworkCore.SqlServer

dotnet ef dbcontext scaffold "Server=VYPC\MISASME2022;Database=MISASME2022Sample;Trusted_Connection=True;" Microsoft.EntityFrameworkCore.SqlServer -o Models
Severity	Code	Description	Project	File	Line	Suppression State
Error	SA1514	Element documentation header should be preceded by blank line	Domain	C:\Users\donhu\source\repos\FSH\src\Core\Domain\Entities\Catalog\Account.cs	223	Active

image

image

Related https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1517.md

@ErikEJ
Copy link
Contributor

ErikEJ commented Jun 8, 2022

Or disable code analysis from generated code?

@donhuvy
Copy link
Author

donhuvy commented Jun 8, 2022

Because has other XML documents not belong to automated generated XML documents. I think add empty line below XML document is more suitable.
Update: https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/

(2) I add more information: StyleCopAnalyzers from this project fullstackhero/dotnet-starter-kit#703 also require . (dot) at the end of XML doc. For example

This is a regular doc

will cause error.

StyleCopAnalyzers from this project fullstackhero/dotnet-starter-kit#703 also require

This is a regular doc.

have . (dot) at the end of doc will not cause error.

But I have little experience in C# / .NET development. Please consider this fact from your side.

@ajcvickers ajcvickers added this to the 7.0.0 milestone Jun 13, 2022
bricelam added a commit to bricelam/efcore that referenced this issue Jul 29, 2022
This refactors our existing scaffolding code into T4 templates that we can both precompile to use as our default code generator and also ship somehow (probably `dotnet new`) as a starting point for users to start customizing.

Part of dotnet#4038, part of dotnet#14545, fixes dotnet#25473, resolves dotnet#25546, resolves dotnet#25547, fixes dotnet#27087, part of dotnet#27588, fixes dotnet#28187
@bricelam bricelam added the closed-fixed The issue has been fixed and is/will be included in the release indicated by the issue milestone. label Jul 29, 2022
bricelam added a commit to bricelam/efcore that referenced this issue Aug 1, 2022
This refactors our existing scaffolding code into T4 templates that we can both precompile to use as our default code generator and also ship somehow (probably `dotnet new`) as a starting point for users to start customizing.

Part of dotnet#4038, part of dotnet#14545, fixes dotnet#25473, resolves dotnet#25546, resolves dotnet#25547, fixes dotnet#27087, part of dotnet#27588, fixes dotnet#28187
bricelam added a commit to bricelam/efcore that referenced this issue Aug 8, 2022
This refactors our existing scaffolding code into T4 templates that we can both precompile to use as our default code generator and also ship somehow (probably `dotnet new`) as a starting point for users to start customizing.

Part of dotnet#4038, part of dotnet#14545, fixes dotnet#25473, resolves dotnet#25546, resolves dotnet#25547, fixes dotnet#27087, part of dotnet#27588, fixes dotnet#28187
@bricelam bricelam modified the milestones: 7.0.0, 7.0.0-rc1 Aug 10, 2022
@ajcvickers ajcvickers modified the milestones: 7.0.0-rc1, 7.0.0 Nov 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-scaffolding closed-fixed The issue has been fixed and is/will be included in the release indicated by the issue milestone. customer-reported type-bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants