C# méthode paramètres API design

Question

Je souhaite discuter de la méthode API.

Nous construisons aC# dll qui sera responsable de certaines actions de la machine (comme la porte ouverte, fermer la porte, etc.) Je veux exposer au client une fonction (appelons-le "doAction (paramètres ...) "). Cette fonction aura un paramètre, et le paramètre est le type de l'action (un argument).

Ma question est: quelle est la meilleure façon de concevoir l'argument et si vous pouvez me donner des liens vers des exemples. Cela peut être un aclass de const. cordes ou classe d'énumérations, tout ce qui peut être professionnellement conçu et pourtant facile à utiliser.

Merci.

Answer 1

Jetez un oeil à Action Delegate

Autre que cela, vous voudrez peut-être mettre en œuvre un IActioninterface avec une méthode DoAction.

Donc, quelque chose comme

interface IAction 
{ 
    void DoMethod(); 
} 

et

public class OpenDoor : IAction 
{ 
    public void DoMethod() 
    { 
     //Open the door 
    } 
} 

Answer 2

Il semble plus naturel d'exposer chacun d'entre eux comme une méthode distincte, comme dans:

public class Machine 
{ 
    public void OpenDoor(); 
    public void CloseDoor(); 
    // other methods 
} 

Ce serait utilisé comme suit:

Machine NewMachine = new Machine(); 
NewMachine.OpenDoor(); 
NewMachine.CloseDoor(); 

Ce code est très lisible.

Cependant, si vous êtes vraiment intéressé à le faire tout d'une méthode, une valeur dénombrée peut suffire:

public class Machine 
{ 
    public enum Action 
    { 
     OpenDoor, 
     CloseDoor, 
     // other values 
    } 

    public void DoAction(Action ActionToDo) 
    { 
     switch(ActionToDo) 
     { 
      case OpenDoor: 
       // open the door 
       break; 
      case CloseDoor: 
       // close the door 
       break; 
      default: 
       break; 
     } 
    } 
}