代码之家 › 专栏 › 技术社区 › Dave

在公共API中,如何最好地传达字符串参数的用途?

frameworks c#

Dave · 技术社区 · 14 年前

根据中发布的指南 New Recommendations for Using Strings in Microsoft .NET 2.0 ,字符串中的数据可能显示以下行为类型之一:

考虑到这一点,我想知道在公共API中通信期望的字符串参数行为的最佳方法。我找不到答案 Framework Design Guidelines .

考虑以下方法:

   f(string this_is_a_linguistic_string)
   g(string this_is_a_symbolic_identifier_so_use_ordinal_compares)

变量命名和XML文档是我能做的最好的吗?我可以以某种方式使用属性来标记字符串的需求吗?

现在考虑以下情况:

   h(Dictionary<string, object> dictionary)

请注意,字典实例是由调用方创建的。如何沟通被叫方希望字典所持有的IEqualityComparer<string>对象执行不区分大小写的顺序比较?

2 回复 | 直到 11 年前

Aaronaught 14 年前

你可以一直使用修改过的匈牙利惯例(我的意思是 Joel-approved kind ):

“i”和“s”在这里的含义是一致的,尽管它们可以表示两种不同的东西,这取决于上下文,这是一个有用的属性。我的意思是“不关心”(关于案例/文化),而“S”的意思是“关心”。

当然,作为免责声明,我从不这样做,因为对于我处理的绝大多数字符串,这些类型的字符串之间的区别充其量是模糊的。但是,如果它们对您有语义意义,那么这将是依赖XML文档的合理替代方法。尤其是当您将它们用作私有方法的参数时,大多数人不会为这些方法编写XML文档。

GvS 14 年前

使用文档语法:

/// <param name="dictionary">
/// ... string is case sensitive ordinal ...
/// </param>

推荐文章

asdhkjahjsdjkhjklasdhjhasDKJhl · 有没有办法检测c#中的鼠标侧键按下?

2 年前

user1536880 · 无法将MVC framework升级到。net6。0

3 年前

user591410 · 框架内包含非模块化标头错误

7 年前

Joseph Mancuso · Masonite-craft new命令抛出模块“urllib”没有属性“urlopen”错误

7 年前

user5911925 · Laravel刀片:模板未渲染

7 年前

Xami Yen · CockroachDB和Microsoft实体框架

7 年前

Linux Geek · typedef的用例

7 年前

Mark Fleming · 实体框架6代码优先-多个模型/配置

7 年前

Albert Uler Silva Melo · 我是否应该始终使用最具python风格的方式导入模块?

7 年前

VELFR · 如何在使用Papa解析框架将CSV文件转换为JSON时处理“未定义”错误?

7 年前