IAsyncEnumerableを返すメソッドの明確な命名規則はありますか？

C＃5 が非同期プログラミングのasyncおよびawaitモデルを導入した後、C＃コミュニティは、次のように、待機可能な型を返すメソッドに「非同期」サフィックスを追加する命名規則に到達しました。

interface Foo
{
   Task BarAsync();
}

多くの静的コードアナライザー（Roslynベースと非Roslynベースの両方）は、非同期プログラミングに関するコードのにおいを検出するときに、この命名規則に依存するように作成されています。

C＃8が非同期列挙型の概念を導入したので、それ自体は待機できませんが、と組み合わせて使用​​できます。await foreachメソッドに名前を付けるための2つのオプションが返されるようIAsyncEnumerableです。

interface Foo
{
    // No "Async" suffix, indicating that the return value is not awaitable.
    IAsyncEnumerable<T> Bar<T>();
}

または

interface Foo
{
    // With "Async" suffix, indicating that the overall logic is asynchronous.
    IAsyncEnumerable<T> BarAsync<T>();
}

上記のオプションに関して、C＃5の命名規則が明確に標準化され、プログラマーの意見に基づく判断に委ねられていないなど、明確な命名規則のガイドライン（C＃言語チーム、.NET Foundation、またはその他の機関による）はありましたか？

.NETチームが既に行っていることよりも優れたガイドラインはありません。

• ChannelReader.ReadAllAsyncは、IAsyncEnumerable<T>
• EF Core 3では、AsAsyncEnumerable（）をIAsyncEnumerable呼び出すと結果がとして返されます
• System.Linq.Asyncでは、ToAsyncEnumerable（）は IEnumerables、Tasks、ObservablesをIAsyncEnumerablesに変換します
• の他のすべての演算子はSystem.Linq.Async名前を保持します。SelectAsyncまたはSelectAsAsyncEnumerableはありませんSelect。

すべての場合において、メソッドの結果が何であるかは明らかです。すべての場合において、メソッドの結果は、await foreach使用する前に待つ必要があります。

したがって、実際のガイドラインは同じままです- 名前が動作を明確にすることを確認してください：

• 名前がすでに明確である場合（例：AsAsyncEnumerable()または）ToAsyncEnumerable()、サフィックスを追加する必要はありません。
• それ以外の場合は、Asyncサフィックスを追加して、開発者がawait foreach結果を知る必要があることを確認します。

コードアナライザーとジェネレーターは、メソッドの名前を実際には気にせず、コード自体を検査することで臭いを検出します。コードアナライザを使用すると、タスクまたは待つのを忘れていることを教えてくれますあなたはメソッドや変数を呼び出す方法に関係なく。ジェネレーターは単純にリフレクションを使用してチェックして放出することができますawait foreachIAsyncEnumerableIAsyncEnumerableawait foreach

名前をチェックするのはスタイルアナライザーです。彼らの仕事は、開発者がコードを理解できるように、コードが一貫したスタイルを使用するようにすることです。スタイルアナライザーは、メソッドが選択したスタイルに従っていないことを通知します。そのスタイルは、チームまたは一般的に受け入れられているスタイルガイドです。

そしてもちろん、プライベートインスタンスフィールドの一般的なプレフィックスが_:)であることは誰もが知っています。

これは非同期メソッドではないため、名前の末尾を「Async」にしないでください。そのメソッドのサフィックスは、メソッドが待機する必要があること、または結果がタスクとして処理されることを明確にするための規則です。

通常のコレクションを返す名前が適切だと思います。GetFoos（）など。

非同期のサフィックスとキーワードでさえasync、単なる定型文であり、後方互換性に関するいくつかの引数以外は意味がありません。C＃には、yieldを返すメソッドで区別するのと同じように、これらの関数を区別するためのすべての情報がIEnumerableありenumerableます。

C＃がオーバーロードについて文句を言うからといって、非同期のサフィックスを追加する必要があります。したがって、基本的にこれら2つは同一であり、ポリモーフィズムのすべてのルールによって同じことを行います（意図的に破損する動作の人的要因を考慮していない場合）。

public interface IMyContract
{
    Task<int> Add(int a, int b);
    int Add(int a, int b);
}

しかし、コンパイラは文句を言うので、このように書くことはできません。しかし、ちょっと！それはこの1つの怪物を飲み込むでしょう：

public interface IMyContract : IEnumerable<int>, IEnumerable<long>
{
}

そしてこれさえ：

public interface IMyContractAsync
{
    Task<int> Add(int a, int b);
}

public interface IMyContract : IMyContractAsync
{
    int Add(int a, int b);
}

これでおしまいです。コンパイラーが文句を言うのをやめるためだけにAsyncを追加します。物事を明確にするためではありません。それらを良くしないために。文句がない場合-それを追加する理由はないので、あなたの場合、それがにならない限り、私はこれを避けますTask<IAsyncEnumerable>。

PS：ここで全体像をよりよく理解するために-将来誰かが異なるパラダイムで動作するC＃量子コンピューターメソッド拡張機能（fantazy、huh）を追加する場合、C＃のため、おそらくQuantまたは何かのような別のサフィックスが必要になりますそうでなければ文句を言うでしょう。まったく同じ方法ですが、別の方法で機能します。ポリモーフィズムと同じように。インターフェイスと同じように。