Skip to content

Warnings about invalid XML Comments in generated code #408

@pocki

Description

@pocki

Describe the Bug

Since the update to v2.0 I am getting warnings about invalid XML comments in the generated code.
It seems that there is cref used for referencing to Url - href should be used in this case, and cref to reference code.

Steps to Reproduce

Update to v2.0

\Debug\net8.0\ThisAssembly.Constants\ThisAssembly.ConstantsGenerator\Constants.BuildDateTime.g.cs(42,26,42,31): warning CS1584: XML comment has syntactically incorrect cref attribute 'https :  / / github . com / devlooped # sponsorlink'
\Debug\net8.0\ThisAssembly.Constants\ThisAssembly.ConstantsGenerator\Constants.BuildDateTime.g.cs(42,64,42,64): warning CS1658: Unexpected character '#'. See also error CS1056.
\Debug\net8.0\ThisAssembly.Constants\ThisAssembly.ConstantsGenerator\Git.Branch.g.cs(42,26,42,31): warning CS1584: XML comment has syntactically incorrect cref attribute 'https :  / / github . com / devlooped # sponsorlink'
\Debug\net8.0\ThisAssembly.Constants\ThisAssembly.ConstantsGenerator\Git.Branch.g.cs(42,64,42,64): warning CS1658: Unexpected character '#'. See also error CS1056.
\Debug\net8.0\ThisAssembly.Constants\ThisAssembly.ConstantsGenerator\Git.Commit.g.cs(42,26,42,31): warning CS1584: XML comment has syntactically incorrect cref attribute 'https :  / / github . com / devlooped # sponsorlink'
\Debug\net8.0\ThisAssembly.Constants\ThisAssembly.ConstantsGenerator\Git.Commit.g.cs(42,64,42,64): warning CS1658: Unexpected character '#'. See also error CS1056.
\Debug\net8.0\ThisAssembly.Constants\ThisAssembly.ConstantsGenerator\Git.Sha.g.cs(42,26,42,31): warning CS1584: XML comment has syntactically incorrect cref attribute 'https :  / / github . com / devlooped # sponsorlink'
\Debug\net8.0\ThisAssembly.Constants\ThisAssembly.ConstantsGenerator\Git.Sha.g.cs(42,64,42,64): warning CS1658: Unexpected character '#'. See also error CS1056.
\Debug\net8.0\ThisAssembly.Constants\ThisAssembly.ConstantsGenerator\Git.Root.g.cs(42,26,42,31): warning CS1584: XML comment has syntactically incorrect cref attribute 'https :  / / github . com / devlooped # sponsorlink'
\Debug\net8.0\ThisAssembly.Constants\ThisAssembly.ConstantsGenerator\Git.Root.g.cs(42,64,42,64): warning CS1658: Unexpected character '#'. See also error CS1056.
\Debug\net8.0\ThisAssembly.Constants\ThisAssembly.ConstantsGenerator\Git.Url.g.cs(42,26,42,31): warning CS1584: XML comment has syntactically incorrect cref attribute 'https :  / / github . com / devlooped # sponsorlink'
\Debug\net8.0\ThisAssembly.Constants\ThisAssembly.ConstantsGenerator\Git.Url.g.cs(42,64,42,64): warning CS1658: Unexpected character '#'. See also error CS1056.

Expected Behavior

XML comments should be generated correctly, no warning

Exception with Stack Trace

no exception

Version Info

    <PackageVersion Include="ThisAssembly.Constants" Version="2.0.0" />
    <PackageVersion Include="ThisAssembly.Git" Version="2.0.0" />

Additional Info

.NET 8 project
Visual Studio 2022

Back this issue
Back this issue

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions