Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Generated XML doc `cref` contains unescaped generic arguments: CS1584 / CS1658 / CS1570 warnings

Abierto
  • ¿Algo no está bien?
#2,587 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

@reginaldalfret ya está trabajando en esto.

Desde el 9/10/2026.

  • #2592 de @reginaldalfret — abierto

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
68/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
aws, csharp
Área
backend

Línea de trabajo

Start in the Lambda Annotations source that generates handler XML documentation; the issue does not name a file or test, so first locate the generated cref and its tests. Reproduce with a generic handler and GenerateDocumentationFile enabled. Done when the generated XML uses valid generic-argument syntax or omits the cref, and the build produces no XML documentation warnings.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

bug needs-triage
Describe the bug

When a [LambdaFunction] method has a generic parameter type the
generated handler's XML doc comment contains a cref with < and > written literally. This is invalid XML doc
syntax and produces warnings on every build with GenerateDocumentationFile enabled. It does not depend on any
namespace clash.

Regression Issue
  • Select this option if this issue appears to be a regression.
Expected Behavior

Generic arguments in a cref are written with braces, e.g.
SqsBatchProcessor{MyPayload, MyHandler}, or the cref is omitted from the generated comment. The generated file
then produces no warnings.

Current Behavior

Incorrect references are generated

/// The generated Lambda function handler for <see cref="Handle(Amazon.Lambda.SQSEvents.SQSEvent, Amazon.Lambda.Core.ILambdaContext, Common.Lambda.Queue.SqsBatchProcessor<Acme.EventDistributor.Trigger.Models.EventBridge.EventBridgePutObject, Acme.EventDistributor.Trigger.EventDistributorTrigger>)"/>
Reproduction Steps

Any handler with a generic parameter, built with <GenerateDocumentationFile>true</GenerateDocumentationFile>:

[LambdaFunction]
public Task<SQSBatchResponse> Handle(SQSEvent evt, ILambdaContext ctx,
    [FromServices] SqsBatchProcessor<MyPayload, MyHandler> processor) => ...
Possible Solution

Generic arguments in a cref are written with braces, e.g. SqsBatchProcessor{MyPayload, MyHandler}

Additional Information/Context

Sample solution

AnnotationsNamespaceClash.zip

AWS .NET SDK and/or Package version used

Amazon.Lambda.Annotations 2.4.1

Targeted .NET Platform

.NET SDK 10.0.401

Operating System and version

Windows 11

Lenguaje dominante
C#
Estrellas
1.7k
Forks
505
Merge medio
1 d 6 h
PR fusionados (30 d)
10

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de aws/aws-lambda-dotnet

Todos los issues de aws/aws-lambda-dotnet

Issues similares

Más issues de C#

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.