Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Doc comment errors with tuple method parameters

オープン
#94 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
48/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
静か
技術スタック
csharp
領域
devtools

調査の方向性

Start by reproducing the issue with the two tuple-parameter examples and inspect the generated inheritdoc cref shown in the report. Trace how the source generator formats tuple parameters, then verify that the generated cref resolves in Visual Studio and no CS1584 or CS1658 warnings are produced.

索引モデルが issue の本文から書いたものです。

説明

Great Project! Love it!

i think there is some problem with tuple parameters within comments... any Doc Comments on that method are not rendered on the Interface method in Visual Studio.

Some Method

public List<string> Method((Class1, Class2) param) {}

is generated as:

/// <inheritdoc cref="Namespace.Method((Namespace.Class1, Namespace.Class2))" />
global::System.Collections.Generic.List<string> Method((global::Namespace.Class1, global::Namespace.Class2) param);

and i get no Intellisense after the cref inside the generated inheritdoc comment attribute, meaning it probably cant resolve that method reference.

And in another instance a named tuple parameter even throws a compiler warning CS1584

"XML comment has syntactically incorrect cref attribute 'Namespace.Method((System.DateTime? from, System.DateTime? to))'"

and within that tuple also the warning CS1658:

") expected. See also error CS1026."

List<string> Method((DateTime? from, DateTime? to) timespan) {}

generates:

/// <inheritdoc cref="Namespace.Method((System.DateTime? from, System.DateTime? to))" />
global::System.Collections.Generic.List<string> Method((global::System.DateTime? from, global::System.DateTime? to) timespan);

In that instance it also cant resolve the cref inside the generated inheritdoc comment attribute.

Unfortunately i cannot find a solution at this moment. Any Solution very appreciated!

主要言語
C#
スター
116
フォーク
26
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトの環境構築ファイルはまだ確認していません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

codecentric/net_automatic_interface のほかの issue

codecentric/net_automatic_interface の issue をすべて見る

似ている issue

C# の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。