我正在为拼车/出租车预订开发一套新的API方法,因此如果开发人员需要开发一个应用程序或webportal来进行拼车,他可以调用我的JSON。基本上让开发人员更容易。
我的API当前有:
AddVehicle
AddJourney
SearchJourney
SubscribeToThisJourney(journey)
SubscriberList(journey)
AcceptSubscription(subscriber)
AcceptedSubcriberList
SubscriberList
我需要别人帮我更换订户。当您看到3种方法意味着非常不同的东西:SubscriberList
、SubscribedToThisJourneyList
和AcceptedSubscriberList
时,它很难记住,而且令人困惑。令人困惑的记忆。
我如何命名这些方法,使它们更容易理解和记住?
发布于 2012-11-01 17:15:02
以下是您列出的需要注意的三种方法的名称的一些建议:
SubscriberList
的描述,我想您所说的“谁”指的是哪个提供者,因此更清晰的版本可能是:ProvidersSubscribedTo(user)
。PendingSubscribers(provider)
AcceptedSubscribers(provider)
我使用了参数来指示方法调用的上下文,因此根据调用的方式,它们可能不是必需的。
发布于 2012-11-01 16:49:40
我不认为你选择的名字有什么问题,因为动词subscribe
和名词subscriber
在英语中有着非常不同的(但正确的)相关的含义。
适当的文档将是关键。
https://softwareengineering.stackexchange.com/questions/173208
复制相似问题