dotnet / dotnet/csharplang

[Proposal]: CS1584+CS1658/CS0081 when using constructed generic types in XML comments

Open
#8,988 0 comments 0 reactions 1 assignee View on GitHub

@DustinCampbell is already working on this.

Since Jan 6, 2025.

Proposal champion
Dominant language
C#
Stars
12.7k
Forks
1.1k
Avg merge
11h 1m
Merged PRs (30d)
3

Description

* Discussion: https://github.com/dotnet/csharplang/discussions/8986

## Summary
[summary]: #summary

This code:

```CSharp
///
/// A object that handles the completion of the state machine execution.
///
private readonly TaskCompletionSource> completion;
```

Generates 4 CS1658 warning caused by a CS0081 error in the comment line warnings both in VS2015 and VS2017 and an extra CS1584 warning in VS2017.

By the way, where is the documentation for these errors/warnings?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.