Quand «Try» est-il censé être utilisé dans les noms de méthodes C #?

Nous discutions avec nos collègues de ce que cela signifie si le nom de la méthode commence par "Try".

Il y avait les opinions suivantes:

• Utilisez "Try" lorsque la méthode peut renvoyer une valeur nulle.
• Utilisez "Try" lorsque la méthode ne lèvera pas d'exception.

Quelle est la définition officielle? Que dit "Try" dans le nom de la méthode? Existe-t-il une directive officielle à ce sujet?

Ceci est connu sous le nom de modèle TryParse et a été documenté par Microsoft. La page MSDN officielle sur les exceptions et les performances dit :

Considérez le modèle TryParse pour les membres qui peuvent lever des exceptions dans des scénarios courants pour éviter les problèmes de performances liés aux exceptions.

Ainsi, si vous avez du code pour lequel un cas d'utilisation régulier signifierait qu'il pourrait lever une exception (comme l'analyse d'un int), le modèle TryParse a du sens.

(Corrigé) Il existe une ligne directrice officielle, comme l'a suggéré Erik.

Quand je vois la TrySomethingméthode, je l'assume

• ne jette pas
• Retour bool
• si j'attends une valeur, elle est renvoyée via le paramètre 'out'
• il existe une Somethingméthode qui me permet de gérer toute exception moi-même. (modifier, suggéré par Jesse Webb)

Je pense que vous devriez l'utiliser trylorsque vous voulez continuer. Peu importe qu'une méthode renvoie une valeur ou non.

Cas 1: s'il retourne bien, vous pouvez procéder d'une certaine manière.

Cas 2: s'il ne revient pas: ça va toujours; vous pouvez procéder d'une autre manière.

Et si vous attendez une valeur en sortie de cette méthode, utilisez le outparamètre.

Exemple

int value
if (dictionary.TryGetValue("key", out value))
{
    // Proceed in some way
}
else
{
    // Proceed in some other way
}

Vous devez utiliser "Try" dans le nom de la méthode, lorsque vous voulez manifester le fait que l'invocation de la méthode peut produire un résultat non valide. Selon le standard .NET, ce n'est pas une fonction qui lève une exception, mais la fonction qui renvoie une partie VALIDou NON_VALID, du point de vue du programme, une valeur.

À la fin, tout cela sur la convention de dénomination que vous décidez d'utiliser dans votre groupe.

Assurez-vous d'inclure trydans votre nom de méthode si:

• tu ne lances aucune exception
• votre méthode a la signature suivante: bool TrySomething(input, out yourReturn)

Donc, fondamentalement, si nous utilisons try-methods, nous ne récupérons qu'un résultat booléen.

Ainsi, le code suivant ne lèvera aucune exception:

string input = "blabla";
int number;
if (int.TryParse(input, out number))
{
// wooohooo we got an int!
} else
{
//dooh!
}

Alors que ce code peut (et dans ce cas sera) lever des exceptions:

string input = "blabla";
int number;
try
{
     number = int.Parse(input); //throws an exception
}
catch (Exception)
{
     //dooh!
}

L'utilisation des méthodes Try est un moyen plus sûr et plus défensif de coder. De plus, l'extrait de code n ° 2 nécessite plus de performances à exécuter s'il ne s'agit pas d'un entier.

Oncle Bob donne l'exemple ci-dessous dans son livre Clean Code . Chaque fois que nous nous attendons à ce qu'une exception soit levée, nous pouvons utiliser le Trypréfixe d'un nom de méthode:

public void sendShutDown()
{
    try{
        tryToShutDown();
    } catch (DeviceShutDownError e) {
        logger.log(e);            
    }
}

Et puis (adapté):

private void tryToShutDown()
{
    //some code with no error handling, but
    //something might go wrong here
}

La tryToShutDownméthode n'effectue aucune gestion des erreurs, car c'est la responsabilité de la sendShutDownméthode.

Le TryParsemodèle de Microsoft enfreint la directive de code propre qui dit que nous devons éviter les paramètres de sortie.

Si nous ne développons pas une nouvelle version de C #, nous n'avons pas à nous en tenir à toutes les directives de Microsoft. Parfois, ils ne sont pas les meilleurs.