命名约定和语法

时间:2013-02-08 10:00:03

标签: naming-conventions naming

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

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

DateEnd方法允许更容易地找到与组相关的属性(intellisense& docs): DateStart,DateEnd ...... 但我们不使用像IdTask,TypeProperty这样的名称。我们使用TaskId和PropertyType。最后一个在语法上更正确。

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

1 个答案:

答案 0 :(得分:0)

遵循惯例,通常是语法,有助于使API直观且令人难忘 如你所知,TaskId比IdTask更常见,所以应该首选。

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

Exchange Web Services Task element为例,提醒属性按“提醒”开头分组,例如

  • ReminderDueBy
  • ReminderIsSet

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

有趣的是,这个Microsoft示例不一致,因为大多数日期都以“StartDate”,“DueDate”命名,但其他日期不符合约定,例如“DateTimeSent”和“DateTimeCreated”。