search

CollinAlpert / Lombok.NET

.NET adaptation for Java's Lombok using Source Generators.
MIT License
309 stars 16 forks source link

Missing XML comment for publicly visible type or member #37

Closed View12138 closed 8 months ago

View12138 commented 8 months ago

Describe the bug When the documentation file generation feature was enabled (<GenerateDocumentationFile>True</GenerateDocumentationFile>) on the project, the generated code caused the compiler to report a warning Compiler Warning (level 4) CS1591

To Reproduce

<Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
        <TargetFramework>net8.0</TargetFramework>
        <GenerateDocumentationFile>True</GenerateDocumentationFile>
    </PropertyGroup>
</Project >

Screenshots image image

Environment info

CollinAlpert commented 8 months ago

Unfortunately this is a known issue with generated code. The fix is to suppress the error for generated files in your .editorconfig like this:

[*.g.cs]
dotnet_diagnostic.CS1591.severity = none
CollinAlpert commented 8 months ago

Related to https://github.com/CollinAlpert/Lombok.NET/issues/24.