Ajout de commentaires dans ASP

• Mai 14, 2024

Parfois, ce sont les choses simples qui déroutent les gens. Comment ajoutez-vous des commentaires à votre code ASP pour le rendre plus lisible et documenté?

C'est très simple - il vous suffit de mettre un seul guillemet (') au début de votre ligne d'ASP. Donc, votre code pourrait ressembler à ceci -

«initialiser les variables»
CurrMonth = demande ("m")
CurrDay = demande ("d")

Notez que j'ai mis une apostrophe avant ET après mon commentaire. Tu n'as pas à faire ça. Mais j'utilise l'éditeur TextPad (que je recommande fortement) et il met automatiquement en évidence les choses en fonction du début et de la fin d'une apostrophe. Donc, en mettant un à chaque extrémité de mes commentaires, je leur donne une couleur différente.

Les commentaires ne sont PAS interprétés, vous pouvez donc y mettre ce que vous voulez. Cependant, bien que les commentaires soient importants pour garder une trace de ce que vous faites, je ne recommande PAS de mettre une tonne de commentaires dans votre code. N'oubliez pas que l'intégralité de votre fichier doit être analysée et traitée avant que le résultat ne soit envoyé à l'utilisateur final. Si vous écrivez Guerre et Paix dans vos commentaires, il faudra un certain temps avant que ce fichier ne parvienne à votre utilisateur final - ce qui signifie qu'il pourrait abandonner et aller ailleurs. Vous souhaitez que vos pages ASP en direct soient aussi rationalisées que possible.

Je recommande donc de mettre des commentaires au-dessus de chaque bloc de code majeur, donc si vous devez entrer et le déboguer des mois plus tard, vous vous souviendrez de ce que vous faisiez. Ajoutez peut-être une ligne ou deux en haut avec la dernière date de modification et le nom de l'auteur. Mais laissez toute la documentation robuste séparée. Le but principal du code ASP à la fin est de créer une page Web pour un utilisateur - et dans ce sens, une action rapide est d'une importance primordiale.

Instructions Vidéo: VB.NET | Tutoriel 6 - Les Commentaires (Mai 2024).