gpt4 book ai didi

c# - .NET API 文档是否应该定义/公开枚举成员的文字(数字)值?

转载 作者:太空狗 更新时间:2023-10-30 01:36:16 26 4
gpt4 key购买 nike

<分区>

作为一名软件开发人员,我想为我制作的 API(作为产品的一部分提供)提供文档,以便我的客户可以有效地使用该 API,而无需在深夜给我打电话。

此 API 以各种形式提供,包括 .NET 程序集。 .NET 程序集包括用于输出的枚举(特别是返回代码)。我之前看到一些关于这种方法优点的讨论:Should enum never be used in an API? ...所以我会继续。

例如,对服务器的请求将得到一个结果,该结果只是一个数字,在 .NET API 中,这将作为枚举结果返回 - 这样的东西:

public enum ApiResult {
/// <summary>
/// Success
/// </summary>
Ok,
/// <summary>
/// Input parameter was incorrect
/// </summary>
InvalidParameter,
/// <summary>
/// The method failed
/// </summary>
OperationFailed
}

我的问题是:.NET API 文档是否应该只包含枚举成员和描述? ...或者它还应该包括枚举成员的文字值(即服务器发回的内容)吗?

我可以看出这是一个哲学问题,我真的想不出一个引人注目的 C# 应用程序需要知道枚举成员的字面值。有没有人有例子?

最后我要补充一点,我们还提供等效的 API,包括 OLE/COM,其中记录了枚举成员,包括它们的文字数值。

26 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com