Quand dois-je utiliser Debug.Assert() ?

Question

Je suis ingénieur logiciel professionnel depuis environ un an maintenant, après avoir obtenu un diplôme en informatique. Je connaissais les assertions depuis un certain temps en C++ et C, mais je ne savais pas du tout qu'elles existaient en C# et .NET jusqu'à récemment.

Notre code de production ne contient aucune assertion et ma question est la suivante...

Devrais-je commencer à utiliser les alertes dans notre code de production ? Et si oui, quand son utilisation est-elle la plus appropriée ? Serait-il plus judicieux de faire

Debug.Assert(val != null);

ou

if ( val == null )
    throw new exception();

Answer 1

Sur Débogage des applications Microsoft .NET 2.0 John Robbins a une grande section sur les assertions. Ses principaux points sont :

1. Affirmez librement. On ne peut jamais avoir trop d'affirmations.
2. Les assertions ne remplacent pas les exceptions. Les exceptions couvrent les choses que votre code exige ; les assertions couvrent les choses qu'il suppose.
3. Une assertion bien rédigée peut vous dire non seulement ce qui s'est passé et où (comme une exception), mais aussi pourquoi.
4. Un message d'exception peut souvent être énigmatique, vous obligeant à travailler à rebours dans le code pour recréer le contexte qui a causé l'erreur. Une assertion peut préserver l'état du programme au moment où l'erreur s'est produite.
5. Les assertions font office de documentation, indiquant aux autres développeurs les hypothèses implicites dont dépend votre code.
6. La boîte de dialogue qui apparaît lorsqu'une assertion échoue vous permet d'attacher un débogueur au processus, de sorte que vous pouvez fouiller dans la pile comme si vous aviez placé un point d'arrêt à cet endroit.

PS : Si vous avez aimé Code Complete, je vous recommande de le suivre avec ce livre. Je l'ai acheté pour apprendre à utiliser WinDBG et les fichiers de vidage, mais la première moitié est remplie de conseils pour éviter les bogues en premier lieu.

Answer 2

Mettez Debug.Assert() partout dans le code où vous voulez avoir des contrôles de sanité pour assurer les invariants. Lorsque vous compilez une version Release (c'est-à-dire, sans DEBUG constante du compilateur), les appels à Debug.Assert() seront supprimés afin de ne pas affecter les performances.

Vous devez toujours lever des exceptions avant d'appeler Debug.Assert() . L'asserteur s'assure simplement que tout se passe comme prévu pendant que vous êtes encore en train de vous développer.

Answer 3

De Code complet

8 Programmation défensive

8.2 Assertions

Une assertion est un code utilisé pendant le développement - généralement une routine ou une macro - qui permet à un programme de se vérifier pendant son exécution. ou une macro - qui permet à un programme de se vérifier pendant son exécution. Lorsqu'une assertion est vraie, cela signifie que tout fonctionne comme prévu. Si elle est fausse, cela signifie qu'elle a détecté une erreur inattendue dans le code. code. Par exemple, si le système suppose qu'un fichier d'informations sur le client client ne contiendra jamais plus de 50 000 enregistrements, le programme pourrait le programme peut contenir une assertion selon laquelle le nombre d'enregistrements est ou égal à 50 000. Tant que le nombre d'enregistrements est inférieur ou égal à 50 000, l'assertion est maintenue. 50 000, l'assertion sera silencieuse. Si elle rencontre plus de 50 000 enregistrements, par contre, elle "affirme" bruyamment qu'il y a une erreur dans le erreur dans le programme.

Les assertions sont particulièrement utiles dans les programmes complexes et de grande taille et dans les programmes de haute fiabilité. Elles permettent aux programmeurs d'éliminer plus rapidement d'éliminer plus rapidement les hypothèses d'interface inadéquates, les erreurs qui se glissent dans code est modifié, etc.

Une assertion prend généralement deux arguments : une expression booléenne qui booléenne qui décrit l'hypothèse qui est supposée être vraie et un message à message à afficher si elle ne l'est pas.

( )

Normalement, vous ne voulez pas que les utilisateurs voient les messages d'assertion dans le code de production. code de production ; les assertions sont principalement utilisées pendant le développement et la maintenance. Les assertions sont normalement compilées dans le code au moment du développement et retirées du code pour la production. code au moment du développement et compilées hors du code pour la production. Pendant le développement de développement, les assertions permettent d'éliminer les hypothèses contradictoires, les conditions inattendues, les mauvaises valeurs transmises aux routines, etc. Pendant la production, elles sont compilées en dehors du code afin que les afin que les assertions ne dégradent pas les performances du système.

Answer 4

Utilisez des assertions pour vérifier les hypothèses du développeur et des exceptions pour vérifier les hypothèses de l'environnement.

Answer 5

Si j'étais vous, je le ferais :

Debug.Assert(val != null);
if ( val == null )
    throw new exception();

Ou pour éviter un contrôle répété des conditions

if ( val == null )
{
    Debug.Assert(false,"breakpoint if val== null");
    throw new exception();
}