Instructions pour le codage
D'une façon générale, le code de votre comportement de serveur doit être compact et robuste. Les développeurs d'applications Web sont très sensibles au code ajouté à leurs pages. Respectez les règles de codage généralement appliquées pour le langage du type de document concerné (ColdFusion, JavaScript, VBScript ou PHP). Si vous ajoutez des commentaires, tenez compte des différents publics qui devront comprendre le code, tels que les concepteurs de pages Web et d'éléments interactifs ou tout autre développeur d'applications Web. Incluez des commentaires précis décrivant le but du code et ajoutez toutes les instructions utiles pour l'inclure dans une page.
Tenez compte des instructions de codage suivantes lors de la création de comportements de serveur :
- Le contrôle des erreurs
- L'un des éléments indispensables. Le code du comportement de serveur doit être en mesure de traiter les cas d'erreur avec élégance. Essayez de prévoir toutes les éventualités. Exemple : Que se passe-t-il si une demande de paramètre échoue ? Si aucun enregistrement n'est envoyé suite à une requête ?
- L'utilisation de noms uniques
- Permet de s'assurer que le code est clairement identifiable et d'éviter tout conflit entre le nom employé et un nom déjà utilisé dans le code existant. Si la page contient une fonction appelée hideLayer(), une variable globale appelée ERROR_STRING et que le comportement de serveur insère un code utilisant ces mêmes noms, par exemple, ce comportement risque d'entrer en conflit avec le code existant.
- Les préfixes de code
- Permettent d'identifier les fonctions d'exécution et les variables globales insérées dans une page. Une convention consiste à employer vos propres initiales. N'utilisez jamais le préfixe MM_, qui est exclusivement réservé à l'usage de Dreamweaver. Dreamweaver fait précéder toutes les fonctions et variables globales du préfixe MM_ pour les empêcher d'entrer en conflit avec le code que vous écrivez.
var MM_ERROR_STRING = "...";
function MM_hideLayer() {
- Evitez les blocs de code similaires
- de sorte que votre bloc ne ressemble pas trop au code d'autres blocs. En effet, si un bloc de code ressemble un peu trop à un autre bloc figurant sur la page, le panneau Comportements de serveur risque d'identifier par erreur ce premier bloc comme une occurrence du deuxième (ou l'inverse). Pour éviter ce problème, ajoutez par exemple un commentaire à un bloc de code pour le rendre plus unique.