Rob*_*los 8 .net c# api naming-conventions
我正在设计一个供公众使用的.NET API.在我的API中,有一堆枚举,我正在努力决定用于后缀的约定.
在.NET框架中,我看到使用"Kind"(例如System.DateTimeKind)以及"Type"(例如System.IO.DriveType)的示例.
查看mscorlib中的公共枚举,我看到"Type"被更频繁地使用,但两者仍然在一些较新的类型上使用,这意味着它看起来像Microsoft没有遵循任何特定的约定.
有没有人建议我在API中使用什么？是否有任何已发布的公约涵盖此主题？
我倾向于使用"Kind"作为后缀,并保留术语"Type"来处理System.Type对象或数据类型.
我从 Microsoft 了解到的与枚举相关的唯一命名约定是这个（来自msdn）
- Enum 类型和值名称使用 Pascal 大小写。
- 谨慎使用缩写。
- 不要在 Enum 类型名称上使用 Enum 后缀。
- 大多数枚举类型使用单数名称，但对于位字段的枚举类型使用复数名称。
- 始终将 FlagsAttribute 添加到位字段枚举类型。
它很旧，但没有看到任何与此相关的更新。
我认为没有人可以告诉您针对您的具体问题的“正确”方法，因为这两个选项都是有效的，这只是一个品味问题。
我想说你应该与团队达成一个共同的策略并坚持下去。我认为每个人都使用相同的命名约定比你使用哪一个更重要。
我个人使用Type后缀，但这只是一个品味问题。
| 归档时间： |
|
| 查看次数： |
1493 次 |
| 最近记录： |