应该返回Task的API中的方法是否以Task或Async结尾

Question

如果API具有同步方法T DoSomething<T>();,则相应的异步方法返回时的命名约定是什么Task<T>？

Task<T> DoSomethingTask<T>();    

要么

Task<T> DoSomethingAsync<T>();

或者是其他东西？

Answer 1

如果您正在谈论一个async或await方法,那么从MSDN:

按照惯例,后缀"Async"将添加到由Async或async修饰符修改的方法的名称中.

...

可以在事件,基类或接口契约建议不同名称的情况下对约定进行例外处理.例如,最好不重命名常用事件处理程序的名称,例如button1_Click.

Answer 2

从我在C#5/.NET 4.5中看到的,首选名称是DoSomethingTaskAsync或DoSomethingAsync

例如,.NET 4.5中的WebClient类有类似的方法DownloadFileTaskAsync,因为它已经有一个名为的方法DownloadFileAsync,所以我假设使用TaskAsyncover Async是为了保持向后兼容性.