2013-02-08 181 views
0

我很想知道关于语法相关/英语相关命名属性(而不是大写等)的规则。命名约定和语法

什么是建议的方式来命名类属性(公共API):DateEnd或EndDate?

DateEnd方法允许发现更容易和组相关的属性(智能感知&文档): DateStart,DateEnd ...... 但我们不喜欢IdTask,TYPEPROPERTY使用的名称。我们使用TaskId和PropertyType。最后一个更符合语法。

那么为什么使用谷歌搜索显示两种方式都使用〜50/50?微软在公共API中都使用。

回答

0

以下惯例和语法经常用于使API直观且令人难忘。
正如你所建议的,TaskId比IdTask更常见,所以应该是首选。

如果不使属性名称过于模糊,对相关属性进行分组是非常有用的。

使用Exchange Web Services Task element作为一个例子,因为它们开始与 “提醒” 提醒属性被分组,例如

  • ReminderDueBy
  • ReminderIsSet

在隔离, “HasReminder” 可能是使用,但可以更改为“ReminderIsSet”以允许分组,而不会牺牲语法或可读性。

有趣的是,这个微软的例子并不一致,因为大多数日期的名称都是例如“StartDate”,“DueDate”,但其他人不遵循约定,例如“DateTimeSent”和“DateTimeCreated”。