Visual Studio 2010 – Développez pour le web est un livre écrit par Julien Dollon (@juliendollon) et James Ravaille, 2 MVPs, sur le développement complet d’une application web sur Visual Studio 2010 en .NET 4.

Tout le livre est construit sur la création d’une application en suivant les étapes une à une. Le projet final est également disponible en téléchargement sur le site de ENI.

Voici la table des matières :

- Architecture du logiciel
- Création du composant d’accès aux données
- Implémentation de la base de données
- Implémentation des règles et traitements métier
- Développement d’une application web avec ASP.NET 4
- Développement RIA avec Silverlight 4
- Création de la couche service
- Implémentation de la version Windows Phone 7

Ce que j’en pense

Ce que j’aime dans ce livre c’est qu’il ne se focalise pas sur une seule technologie (ASP.NET, Silverlight…) et une seule plateforme (web, mobile).  De plus il convient aux développeurs débutants souhaitant découvrir de nouvelles technologies, mais aussi aux développeurs plus expérimentés avec des concepts un peu plus poussés.

Un atout pour beaucoup de lecteurs, ce livre est écrit en français. On sait que toutes les références dans ce domaine sont écrits en anglais et font la plupart du temps plus de 600 pages ce qui peut en décourager plus d’un.

Contrairement à beaucoup de livres, ce livre ne comporte pas de longs passages théoriques un peu rébarbatifs, mais tout est illustré par un cas pratique. Le livre se lit donc très bien.

Pour le petit côté négatif, certains points pourraient être selon moi un peu plus explicités, ce qui peut bloquer les plus novices.

Conclusion

Un très bon livre sur les dernières technologies .NET (ASP.NET 4, SL 4, WP7) à posséder dans sa bibliothèque.

Pour vous procurer ce livre, rendez-vous sur Amazon.

jQuery, la bibliothèque javascript créée par John Resig, choisie par Microsoft pour embellir ASP.NET est désormais intégrée à Visual Studio 2010 avec l’intellisense (auto-complétion).

Cette auto-complétion fonctionne avec les fichiers xxxx-vsdoc.js disponibles sur le site de jQuery.

Le lien « Visual Studio » pointe vers le fichier jquery-1.4.1-vsdoc.js correspondant au fichier javascript de la librairie jquery-1.4.1.js. Ces 2 fichiers doivent être placés dans le même dossier et respecter le même format comme décrit ci-dessous :

Le fichier script.js contient notre code utilisant jQuery. C’est dans ce fichier que nous souhaitons bénéficier de l’intellisense. Cependant par défaut, aucune complétion n’est disponible pour jQuery. Afin d’activer la complétion dans notre fichier script.js, glisser-déposer depuis l’explorateur de solution le fichier jquery-1.4.1.js dans la fenêtre de code du fichier script.js.

Une fois cette opération effectuée un commentaire apparaît dans le code :  l’intellisense est disponible :

Note : Si le fichier xxx-vsdoc.js est renommé ou ajouté ultérieurement, un redémarrage de Visual Studio 2010 peut être nécessaire pour obtenir l’intellisense.

Au 1er démarrage de Visual Studio 2010, un assistant propose de choisir quel type de développement vous allez pratiquer le plus souvent (C#, C++, Web, etc…).

Ce choix va notamment influer sur les propositions faites lors de la création d’un nouveau projet. Ici mon Visual Studio est configuré avec les options « Visual C# ». Lors de la création d’un nouveau projet, Visual Studio ne me propose que des projets en C# :

Les projets en VB.NET, C++, etc… sont répertoriés dans la section « Other Languages ».

Si après avoir choisi un type de développement, vous souhaitez modifier cette option, rendez-vous dans le menu Tools -> Import and Export Settings puis cochez Reset all settings. Choisissez ensuite de sauvegarder ou non vos options puis vous retrouvez  le même assistant qu’au 1er démarrage de Visual Studio 2010.

Attention: Cette opération réinitialise toutes les options de Visual Studio 2010. Toutes les modifications faites dans les options seront effacées. Par précaution sauvegarder votre configuration avant de faire cette opération.

Visual Studio 2010 intègre un module d’extensions afin de personnaliser ou ajouter des fonctionnalités à l’IDE.

Ce module d’extensions est disponible dans Tools -> Extension Manager ou via l’icône  de la barre d’outils.

Via la rubrique Online Gallery, vous pouvez ajouter simplement des extensions à Visual Studio 2010.

Dans cet article, je vous propose de découvrir 3 extensions qui à mon sens sont inévitables pour gagner du temps et de la lisibilité :

• Productivity Power Tools

Ce module, le plus complet des 3 extensions présentées dans cet article ajoute une multitude de fonctionnalités qu’il n’est pas possible d’énumérer dans un seul article. Parmi les fonctionnalité les plus utiles :

• En faisant Ctrl + Click sur une variable ou une méthode, Visual Studio 2010 ouvre le fichier contenant la définition de ce qui a été cliqué et surligne la 1re ligne de déclaration.
• L’ajout de guideline (guide) dans une page de code permet d’aligner des éléments, ou de ne pas dépasser un certain nombre de caractères par ligne. Pour ajouter un guide, placez le curseur à l’endroit où vous souhaitez ajouter le guide, puis click droit -> Guidelines -> Add Guideline

• le Solution Navigator permet de classer les fichiers ouverts, édités, sauvegardés, etc…. Le solution Navigator se trouve à côté du Solution Explorer

Beaucoup d’autres fonctionnalités sont disponibles via ce module : auto-complétion, informations sur les variables, etc…

• VS10x Code Map

Ce module ajoute sur la droite ou la gauche de la fenêtre de code une carte du code regroupé par régions, méthodes, etc… une simple click sur la méthode en question affiche la 1re ligne de la définition de la méthode dans la page de code. Ce module permet également de déplier ou replier toutes les régions contenu dans la page.

• VS10x Method Block Highlighter

Ce module fonctionne avec VS10x Code Map et permet de surligner la définition complète d’une méthode lorsque l’on clique sur la méthode en question dans le Code Map décrit ci-dessus.

Un click droit sur une méthode dans le Code Map puis Highlight In Code -> Green permet de surligner toute la méthode de façon permanente en vert. Très utile pour se repérer rapidement dans le code.

Pour plus de modules rendez-vous sur le site de la galerie Visual Studio 2010.

Bien documenter son code est important afin d’aider d’une part d’autres développeurs à comprendre le code le plus rapidement possible mais aussi à soi-même afin d’être le plus efficace possible lors de la maintenance du code.

Visual Studio utilise le XML pour ses commentaires, pour par exemple ajouter une description à une méthode.

        /// <summary>
        /// Tests the specified param1.
        /// </summary>
        /// <param name="param1">The param1.</param>
        /// <param name="param2">The param2.</param>
        /// <param name="param3">The param3.</param>
        /// <param name="param4">The param4.</param>
        /// <returns>This method return 1</returns>
        public int Test(int param1, int param2, int param3, int param4)
        {
            return 1;
        }

Si l’application fait plusieurs milliers de lignes, il est long et fastidieux de documenter chaque méthode, classe, etc…  Souvent la quantité se fait au détriment de la qualité. Pour remédier à cet obstacle et toujours garder un code correctement documenté, il est possible d’utiliser un outil nommé GhostDoc. GhostDoc s’intègre à Visual Studio (de 2005 à 2010) et génère via un raccourci clavier (Ctrl-Shift-D par défaut) la documentation d’une méthode, classe, etc… Seule condition, respecter quelques standards de nommage dans votre code. Par exemple « myParam » pour un paramètre et « DefineTheParam » pour une méthode. En effet GhostDoc va découper les noms de paramètres, méthodes, etc… afin de construire des phrases dans la documentation.

Pour utiliser GhostDoc, séléctionner l’entité (méthode, classe, etc…) et faire Ctrl-Shift-D pour générer la documentation.

Ainsi la méthode :

        public void DefineTheSentence(string sentenceToDefine)
        {
        }

générera la documentation :

        /// <summary>
        /// Defines the sentence.
        /// </summary>
        /// <param name="sentenceToDefine">The sentence to define.</param>

GhostDoc offre la possibilité d’ajouter des règles à appliquer pour certaines méthodes, classes, etc… Il est par exemple possible de rajouter son nom dans toutes les documentations des classes ou seulement de certaines méthodes contenant par exemple le mot « Private ».

Ces modifications se réalisationt via le menu Tools > GhostDoc > Configure GhostDoc

Cliquer sur une catégorie puis sur Add pour ajouter une nouvelle règle.

Dans l’exemple suivant, toutes les classes qui ont un nom contenant le mot « Private » auront le nom du propriétaire dans la description.

Cliquer sur type name <any>

Il est possible de tester la condition. Ici MyPrivateClass correspond à notre condition. Cliquer sur OK.

A côté de <summary>, cliquer sur le bouton contenant les …

Ajouter $(Environment.UserName) dans Template Text pour ajouter le nom du propriétaire de la classe.

Cliquer successivement sur OK pour enregistrer la règle.

Désormais, lorsque GhostDoc rencontrera une classe contenant « Private », la documentation contiendra le nom du propriétaire.

Exemple :

    class MyPrivateClass
    {
    }

aura pour documentation

    /// <summary>
    /// Aymeric
    /// </summary>

Astuce : Si un changement est fait dans le code (changement de nom, des paramètres, etc…), sélectionner simplement le nom de la méthode (classe, interface, etc…) et faite Crtl-Shift-D pour re-générer la documentation.