2013-02-08 179 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」。