IntelliTect / IntelliTect/CodingGuidelines

Flag optional arguments on methods that differ from their interface declarations

Ouverte
#102 5 commentaires 0 réactions 4 personnes assignées Réclamée par @GrantErickson Voir sur GitHub
documentation
Langage dominant
C#
Étoiles
12
Forks
16
Merge moyen
2 min
PR mergées (30 j)
7

Description

Consider the following case:
```C#
public class Foo : IFoo
{
public void Bar(int value = 2) => Console.WriteLine(value);
}
public interface IFoo
{
public void Bar(int value = 1);
}

public static void Main(string[] args)
{
IFoo foo1 = new Foo();
foo1.Bar();
var foo2 = new Foo();
foo2.Bar();
}
```
Output:
```
2
1
```

I would propose that the coding standard be
```
DO NOT: declare optional arguments on class methods that are implementing an interface.
```
Rational:
- If these value are not in sync it will cause behavior as shown above.
- It is possible to declare a constant and share it in both places. However, if you have an interface for accessing the class, why is there code bypassing it? If you want to invoke the method using the default value, simply go through the interface.

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.