命名约定和语法



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

建议使用什么方法命名类属性(对于公共API):DateEnd或EndDate?

DateEnd方法可以更容易地找到与组相关的属性(intellisense&docs):日期开始,日期结束。。。但我们不使用像IdTask、TypeProperty这样的名称。我们使用TaskId和PropertyType。最后一个在语法上更正确。

那么,为什么谷歌搜索显示两种方式都使用了50/50呢?微软在公共API中同时使用这两个。

遵循惯例,通常是语法,有助于使API直观而令人难忘
正如您所建议的,TaskId比IdTask更常见,因此应该是首选。

如果不会使属性名称过于模糊,则对相关属性进行分组是一个有用的奖励。

以ExchangeWebServicesTask元素为例,提醒属性以"提醒"开头进行分组,例如

  • 提醒DueBy
  • 提醒IsSet

单独使用时,可以使用"HasReminder",但可以将其更改为"ReminderIsSet"以允许分组,而不会牺牲语法或可读性。

有趣的是,微软的这个例子不一致,因为大多数日期都被命名为"StartDate"、"DueDate",但其他日期则不遵循惯例,例如"DateTimeSent"one_answers"DateTimeCreated"。

最新更新