重命名具有相同用途的多个参数的好方法是什么

本文关键字:参数 是什么 方法 重命名 | 更新日期: 2023-09-27 18:00:31

在以下方法中命名参数的常用方法是什么?

void MyMethod(int[] series1, int[] series2) { ... }

那里的两个数组有相同的目的,也许该方法采用两个名称数组,或者两个序列,或者类似的东西。命名此类参数的常用方法是什么?你会用parameter1, parameter2, ...还是firstParameter, secondParameter, ...

如果你能给我一个.NET框架中这样一个方法的例子,我将不胜感激。

重命名具有相同用途的多个参数的好方法是什么

这里有几个例子:

  • Tuple.Create<T1、T2>方法(T1、T2)

    public static Tuple<T1, T2> Create<T1, T2>(T1 item1, T2 item2)
    
  • String.Compare方法(字符串,字符串)

    public static int Compare(string strA, string strB)
    
  • 字符串相等运算符

    public static bool operator ==(string a, string b)
    
  • Object.ReferenceEquals方法

    public static bool ReferenceEquals(Object objA, Object objB)
    
  • XNode.DeepEquals方法

    public static bool DeepEquals(XNode n1, XNode n2)
    
  • 表达式.相等方法(表达式,表达式)

    public static BinaryExpression Equal(Expression left, Expression right)
    
  • TimeSpan.Compare方法

    public static int Compare(TimeSpan t1, TimeSpan t2)
    
  • String.Concat方法(String,String)

    public static string Concat(string str0, string str1)
    

我不认为在整个.NET框架中有一个一致使用的约定
方法名称清楚地表明了参数的含义。

完成此操作的方式很常见。

但是,如果该方法反映了一个文档化的算法,那么使用与该算法匹配的名称会更好。