0

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

命名类属性的推荐方法(对于公共 API):DateEnd 或 EndDate?

DateEnd 方法允许更轻松地查找和分组相关属性(智能感知和文档):DateStart、DateEnd ... 但我们不使用 IdTask、TypeProperty 之类的名称。我们使用 TaskId 和 PropertyType。最后一个在语法上更正确。

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

4

1 回答 1

0

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

如果不会使属性名称过于晦涩,则对相关属性进行分组是一个有用的好处。

Exchange Web 服务任务元素为例,提醒属性以“提醒”开头进行分组,例如

  • 提醒到期
  • 提醒设置

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

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

于 2013-02-08T10:56:01.170 回答