命名异步方法的最佳方法

时间:2011-08-03 11:59:26

标签: api-design

比如说,一个方法的API:“DoSomething()”。该方法应该有两个版本:异步和同步。我们应该鼓励API用户使用异步,因此同步一个可能应该得到更复杂和明确的名称。 所以问题是:我们应该如何命名这一对。到目前为止我们已经提出:

  • DoSomethingAndWaitForResult()/ DoSomething()
  • DoSomething()/ DoSomethingAsync()
  • DoSomethingSync()/ DoSomething()
  • DoSomething()/ RequestSomething()

以上方案似乎都不适合我们。有什么建议吗?

更新。如果适合您,BTW会毫不犹豫地发布以上其中一项作为答案。

3 个答案:

答案 0 :(得分:6)

如果您想鼓励您的用户使用异步同步,那么我会选择这个:DoSomethingSync() / DoSomething()

但是,如果没有另行说明,请告诉您的用户响亮而清晰所有方法都是异步的。

示例:node.js使用以下表示法:fschmodSyncfschmod

但最重要的是坚持你选择的那个

答案 1 :(得分:3)

如何命名它们并使用不同的签名来区分它们(一个具有回调函数,一个没有)?

否则,Adobe使用ActionScript的“Async”后缀,这似乎也很好:http://help.adobe.com/en_US/FlashPlatform/reference/actionscript/3/flash/filesystem/FileStream.html

答案 2 :(得分:1)

在.NET框架中,异步方法以“Begin”开头:BeginDoSomething / DoSomething。