0

文法関連/英語関連の命名プロパティの規則について知りたいです（大文字と小文字の区別などではありません）。

クラスプロパティに名前を付けるための推奨される方法（パブリックAPIの場合）：DateEndまたはEndDate？

DateEndアプローチを使用すると、関連するプロパティ（インテリセンスとドキュメント）をより簡単にグループ化できます。DateStart、DateEnd ...ただし、IdTask、TypePropertyなどの名前は使用しません。TaskIdとPropertyTypeを使用します。そして最後のものはより文法的に正しいです。

では、なぜグーグルは両方の方法が約50/50を使用したことを示しているのでしょうか？マイクロソフトはパブリックAPIで両方を使用しています。

4

1 に答える 1

0

API を直感的で覚えやすいものにするためには、規則に従うこと、そして多くの場合は文法に従うことが役立ちます。
あなたが示唆するように、TaskId は IdTask よりも一般的であるため、優先する必要があります。

関連するプロパティをグループ化すると、プロパティ名がわかりにくくならない場合に便利です。

例としてExchange Web サービス タスク要素を使用すると、リマインダー プロパティは "Reminder" で始まるようにグループ化されます。

  • ReminderDueBy
  • ReminderIsSet

単独で「HasReminder」を使用することもできますが、これを「ReminderIsSet」に変更して、文法や可読性を犠牲にすることなくグループ化できます。

興味深いことに、この Microsoft の例は、ほとんどの日付が "StartDate"、"DueDate" などの名前になっているという点で一貫性がありませんが、"DateTimeSent" や "DateTimeCreated" など、規則に従わないものもあります。

于 2013-02-08T10:56:01.170 に答える