Commentaires dans le code


Lorsque vous travaillez en collaboration avec d'autres personnes, lorsque vous traitez avec un grand projet, ou même simplement pour votre propre référence et débogage, laisser des commentaires dans vos codes et scripts est très important. Dans GameMaker Studio 2 vous disposez de plusieurs mécanismes pour vous aider à laisser des notes et des commentaires sur les sections de code et même des blocs de code entiers visibles dans la liste des événements de l'objet que vous êtes en train d'éditer. vous-même et à vos collègues, ou pour expliquer un code particulièrement délicat, ou même simplement laisser un rappel sur ce que fait quelque chose.

La première chose que vous pouvez faire est de laisser un petit commentaire en utilisant // avant le texte Par exemple:

//initialize variables
sr = 10;
hp = 100;

Vous pouvez aussi laisser des commentaires sur plusieurs lignes, donner crédit, omettre une section complète de code pour le débogage, ou même expliquer les arguments d'un script. Pour cela, vous pouvez utiliser /* ... */ comme ça:

/*
usage:
diff = angle_difference(angle1,angle2);

angle1 first direction in degrees, real
angle2 second direction in degrees, real

returns: difference of the given angles in degrees, -180 to 180

GMLscripts.com
*/
{
return ((((argument0 - argument1) mod 360) + 540) mod 360) - 180;
}

Enfin, si vous écrivez des scripts personnalisés et que vous voulez avoir un certain contrôle sur la façon dont ils sont traités par l'EDI (ex: avoir auto-complet ou afficher les arguments de script), alors vous devriez écrire vos commentaires en utilisant la notation JSDoc comme expliqué ici.