IAsyncEnumerable döndüren yöntemler için kesin bir adlandırma kuralı var mı?

C # 5 , eşzamansız programlama için asyncve awaitmodelini tanıttıktan sonra , C # topluluğu, aşağıdaki gibi beklenen bir tür döndüren yöntemlere bir "Eşzamansız" son ek eklemek için bir adlandırma kuralına geldi:

interface Foo
{
   Task BarAsync();
}

Birçok statik kod analizörü (hem Roslyn tabanlı hem de Roslyn tabanlı değil) o zamandan beri eşzamansız programlama etrafında kod kokusu algılandığında bu adlandırma kuralına bağlı olarak yazılmıştır.

Şimdi C # 8, kendileri beklenmeyen ancak birlikte kullanılabilen asenkron numaralandırılabilir kavramını tanıttığına göre, await foreachgeri dönen yöntemleri adlandırmak için iki seçenek var gibi görünüyor IAsyncEnumerable:

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

veya

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

Yukarıdaki seçeneklerle ilgili olarak, C # 5 adlandırma kuralının nasıl net bir şekilde standartlaştırıldığı ve programcıların fikir tabanlı kararına bırakılmadığı gibi, kesin bir adlandırma kuralları kılavuzu (C # dil ekibinden, .NET Vakfı'ndan veya diğer yetkililerden) var mı?

NET ekipleri olandan daha iyi bir kılavuz var zaten yapın:

• ChannelReader.ReadAllAsync birIAsyncEnumerable<T>
• EF Core 3'te, sonuçlar AsAsyncEnumerable ()IAsyncEnumerable çağrılarak bir
• System.Linq.Async'de ToAsyncEnumerable () , IEnumerables, Görevler ve Gözlemlenebilir ÖğeleriIAsyncEnumerable s
• Tüm diğer operatörler System.Linq.Asyncisimlerini saklı tutarlar. Yok SelectAsyncya da SelectAsAsyncEnumerablesadece Select.

Her durumda, yöntemin sonucunun ne olduğu açıktır. Her durumda, await foreachkullanılmadan önce yöntemin sonuçlarının beklenmesi gerekir .

Böylece gerçek kılavuz aynı kalır - adın davranışı netleştirmesini sağlayın :

• Ad zaten açık olduğunda, örneğin AsAsyncEnumerable()veya ile ToAsyncEnumerable(), herhangi bir sonek eklemenize gerek yoktur.
• Diğer durumlarda, geliştiricilerin sonuca ihtiyaçları olduğunu bilmesi için Asyncsoneki ekleyin .await foreach

Kod analizörleri ve jeneratörleri yöntemlerin isimlerini gerçekten önemsemiyorlar, kodun kendisini inceleyerek kokuları tespit ediyorlar. Bir kod analizörü, bir görev veya beklemek üzere unuttum söyleyecektir await foreachbir IAsyncEnumerableolursa olsun yöntemleri ve değişkenleri çağrı nasıl. Bir jeneratör, kontrol etmek IAsyncEnumerableve yaymak için yansımayı kullanabilirawait foreach

İsimleri kontrol eden stil analizörleri. Görevleri, kodun tutarlı bir stil kullanmasını sağlamaktır, böylece geliştiriciler kodu anlayabilir. Stil analizörü, bir yöntemin seçtiğiniz stile uymadığını söyleyecektir. Bu tarz, ekibin veya yaygın olarak kabul edilen bir stil rehberi olabilir.

Ve tabii ki, herkes özel örnek alanları için ortak önek olduğunu biliyor _:)

Bu bir zaman uyumsuz yöntem değildir, bu nedenle ad 'Zaman uyumsuz' ile bitmemelidir. Bu yöntem soneki, yöntemin beklenmesi veya sonucun bir Görev olarak ele alınması gerektiğini açıkça ortaya koyan bir kuraldır.

Normal bir koleksiyon döndüren adın uygun olduğunu düşünüyorum. GetFoos () veya benzeri.

Async soneki ve hatta anahtar kelime asyncsadece ortak özelliktir, geriye dönük uyumluluk argümanlarından başka anlamsızdır. C #, bu işlevleri , bu yöntemlere benzer bir şey veya başka bir anahtar kelime eklemeniz gerekmediğini bildiğiniz gibi, yielddöndürülen yöntemlerde olduğu gibi ayırt etmek için tüm bilgilere sahiptir .IEnumerableenumerable

Async sonekini sadece C # aşırı yüklerden şikayet edeceği için eklemeniz gerekir , bu yüzden aslında bu ikisi aynıdır ve tüm polimorfizm kuralları ile aynı şeyi yaparlar (eğer insan faktörünü kasıtlı olarak bozan davranışı hesaba katmazsak):

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

Ama bunu böyle yazamazsınız çünkü compilator şikayet edecek. Ama hey! Bu bir canavarlığı yutacak:

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

ve hatta bu:

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

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

İşte bu kadar. Derleyiciyi şikayet etmek için durdurmak için Async'i eklersiniz . Açıklığa kavuşturmamak için. Onları daha iyi yapmak için değil. Şikayet yoksa - eklemek için bir neden yok, bu yüzden olmadıkça, bundan kaçınacağım Task<IAsyncEnumerable>.

Not: Sadece burada tüm resmin daha iyi anlaşılması için - gelecekte birileri farklı paradigmada çalışacak C # kuantum-bilgisayar yöntemi uzantıları (fantazy, huh) eklerse, muhtemelen Quant veya başka bir şey gibi başka bir son eke ihtiyacımız olacaktır , çünkü C # aksi şikayet edecek. Aynı yöntem olacak, ancak başka bir şekilde çalışacak. Tıpkı polimorfizm gibi. Tıpkı arayüzlerin yaptığı gibi.