Api 文档和枚举语义 [关闭]

【问题标题】：Api Documentation and Enum Semantics [closed]Api 文档和枚举语义 [关闭]
【发布时间】：2012-10-02 03:29:38
【问题描述】：

我正在为我的 REST Web 服务创建 API 文档。请求和响应包含一些枚举，但是描述这些的好标题是什么。标题“Enumerations”听起来很编程，我错了吗？

Gender

Male - 1
Female - 2

Pool Team Status

All - 1
Active - 2
Active and Paid - 3

Registration Status

All - 1
Active - 2
Active and Paid - 3

Status

All - 1
Active - 2
Active and Paid - 3

【问题讨论】：

标签： c# api enums documentation

【解决方案1】：

您可以将它们称为选项、替代品或任何其他同义词（如果它们是这样的话）。

尽管如此，假设您正在为其他程序员编写文档，而不仅仅是管理层必须经历的事情，我认为枚举或枚举是好的，因为您的听众会很清楚，这就是您想要实现的目标.

【讨论】：

就我个人而言，我见过：类型、模式、样式、选项和标志。了解上下文将是有益的，因为枚举可以代表许多不同的事物。
我想到了标志，输入可能有意义。
我会使用类似：“以下选项/过滤器可用于指定池团队状态：-全部：... -活动：... -活动和付费：... " 其中 ... 应替换为每个选项/过滤器的描述。