[CS1658,CS1584] Wrong XML comments

[viceice]

Hi, I'm seeing wrongly generated XML comments:

generated:

/// <summary>
/// Exit a parse tree produced by <see cref="EvalScriptParser.break"/>.
/// </summary>
/// <param name="context">The parse tree.</param>
void ExitBreak([NotNull] EvalScriptParser.BreakContext context);

expected:

/// <summary>
/// Exit a parse tree produced by <see cref="EvalScriptParser.@break"/>.
/// </summary>
/// <param name="context">The parse tree.</param>
void ExitBreak([NotNull] EvalScriptParser.BreakContext context);

So the special words need to be escaped by @

[viceice]

antlr4cs/tool/resources/org/antlr/v4/tool/templates/codegen/CSharp/CSharp.stg

Line 56 in bc7fb74

/// labeled alternative in \<see cref="<file.parserName>.<file.listenerLabelRuleNames.(lname)>"/>.

It seems lname must be passed to csIdentifier helper function?

like here:

antlr4cs/tool/resources/org/antlr/v4/tool/templates/codegen/CSharp/CSharp.stg

Line 37 in bc7fb74

/// \<see cref="<csIdentifier.(file.parserName)>"/>.

[viceice]

Those warnings can't easily suppressed 😕

• Feature: Enable setting the "NoWarn" option on a per-file basis dotnet/roslyn#32672

[lextm]

Since this is an upstream issue, you should report to https://github.com/antlr/antlr4/issues

Read #381 and see why you might migrate away to newer NuGet packages.

[viceice]

I already migrated. 😉