Améliorer la lisibilité d'un extrait court tout en gardant StyleCop heureux

Question

Le code ci-dessous m'a semblé correct quand je l'ai écrit, mais quand je suis revenu dessus, il était assez difficile de comprendre ce qui se passait. Il y avait des parenthèses autour de value == ..., mais j'ai dû les enlever après que StyleCop soit devenu obligatoire (je ne peux pas vraiment contrôler cela). Alors, comment puis-je améliorer cette section de code? Je pensais: x = value == y ? true : false;, mais c'est probablement encore plus déroutant, plus stupide, bien que le compilateur optimisera cela.

set 
{ 
    Debug.Assert(value == ConfigType.DATABASE || value == ConfigType.FILE, 
     "Configuration type must be either 'File-based' or 'Database-based'; it was: " 
     + value.ToString()); 

    // HG TODO: The following is concise but confusing. 
    this.fileBasedRadioButton.Checked = value == ConfigType.FILE; 
    this.databaseBasedRadioButton.Checked = value == ConfigType.DATABASE; 
} 

Answer 1

bool isFile = value == ConfigType.FILE; 
bool isDatabase = value == ConfigType.DATABASE; // or isDatabase = !isFile 

Debug.Assert(isFile || isDatabase, 
"Configuration type must be either 'File-based' or 'Database-based'; it was: " 
+ value.ToString()); 

this.fileBasedRadioButton.Checked = isFile; 
this.databaseBasedRadioButton.Checked = isDatabase; 

Cela en fait un peu plus lisible (déclarant explicitement le bool), vous savez qu'il doit être vrai ou faux.

Et de cette façon, si vous avez besoin (peut-être à l'avenir) de modifier les paramètres en fonction de fichier/base de données dans la même méthode, vous avez déjà la bool à portée de main, au lieu de vérifier chaque fois que

Answer 2

Si vous ne souhaitez pas utiliser l'utilisation de l'opérateur ?:if..else. Bien sûr, il est un peu plus verbeux, mais vous ne passerez pas plus de quelques secondes à comprendre.

Dans quelques mois, lorsque vous reviendrez sur ce code, vous serez heureux d'avoir pris 5 lignes supplémentaires. Rendre le code facile à entretenir devrait être votre priorité numéro 1

if (value == ConfigType.FILE) 
    this.fileBasedRadioButton.Checked = true; 
else 
    this.fileBasedRadioButton.Checked = false; 


if (value == ConfigType.DATABASE) 
    this.databaseBasedRadioButton.Checked = true; 
else 
    this.databaseBasedRadioButton.Checked = false; 

Answer 3

Indentation la deuxième et troisième ligne de la méthode Debug.Assert(). Il devrait alors ressembler à ceci:

Debug.Assert(value == ConfigType.DATABASE || value == ConfigType.FILE, 
    "Configuration type must be either 'File-based' or 'Database-based'; it was: " 
    + value.ToString()); 

Je sais que c'est vraiment un changement de style mineur, mais je l'ai toujours trouvé quand je dois passer beaucoup d'arguments ou avoir une déclaration très longue, quand j'INTEMPOREL à un retour à la ligne je devrais mettre en retrait avant le ;.

Il empêche le Debug.Assert() de ressembler à 3 lignes.

En ce qui concerne le value==, je suis d'accord avec l'affiche précédente. Vous devriez faire un boolisDatabase et isFile pour éviter d'appeler un champ de ConfigType deux fois dans votre premier arg.