C#转换函数命名约定

时间:2012-07-25 23:11:48

标签: c# naming-conventions

我有一个将对象转换为nullable int的函数:

public int? ToInt(object x) { ... }

现在我需要另一个函数,如果无法转换,它将返回0而不是null:

public int ToIntSomeOtherName(object x) { ... }

其他功能的好名字是什么? 我知道这似乎微不足道,但我会在很多地方使用这些功能 一个好的命名惯例将是一个很大的优势。

6 个答案:

答案 0 :(得分:5)

我认为ToInt对你的第二种方法更好:

public int ToInt(object x) { ... }

你可以重命名第一个:

public int? ToIntOrNull(object x) { ... }

答案 1 :(得分:2)

ToIntOrDefault怎么样?

这是IEnumerable接口(FirstOrDefault)使用的约定。

答案 2 :(得分:0)

方法的名称首先应该是您(以及您的公司或团队)能够识别和理解的方式。

然而有时这些名字会变得笨拙。我强烈建议使用XML注释来提供有关您的方法的正确文档:

/// <summary>
/// Converts an object to an int.
/// If conversion is not possible, a default int value of 0 is returned.
/// </summary>
/// <param name="x">Object to convert to int.</param>
public int ToInt_NotNull(object x) { ... }

答案 3 :(得分:0)

也许ToZeroForNull可能是您方法的名称。

答案 4 :(得分:0)

DefaultOrValue如何与String.IsNullOrEmpty的等效名称相似

public int DefaultOrValue(object x)
{ 
  int? intconverted = ToInt(x);
  return intconverted.HasValue ? intconverted.Value : 0;
}

答案 5 :(得分:0)

相当随意,但如果它需要是一个整数,我使用ToInt,如果它可以为null,我使用AsInt。这与该语言使用'as'关键字相似。我还使这些方法的'object'扩展方法,它删除了对类型和空值的任何预检查。我还建议ToInt利用AsInt,这样你就不会在解析逻辑上加倍。