Pause café #86. Un guide rapide et facile pour reformater le code dans IntelliJ IDEA

Source : Lightrun En tant que développeur, vous devrez apporter des modifications à la base de code. Et si la base de code n'est pas clairement formatée, le débogage deviendra pour vous beaucoup plus difficile. Les petits changements comme le reformatage et l'indentation appropriée dans le code sont généralement négligés, mais ils aident évidemment à différencier la base de code d'un développeur professionnel de celle d'un débutant. Le maintien d'un formatage et d'une indentation appropriés du code vous aidera à écrire un code plus facile à lire. Cela simplifie la collaboration sur les projets, augmente la vitesse de débogage et de maintenance de la base de code. Le code devient plus lisible et structuré. Est-il possible d’accélérer le processus de reformatage du code ? Cet article vous présentera une méthode simple pour reformater automatiquement le code à l'aide d'IntelliJ IDEA. Vous apprendrez comment réduire le temps requis pour cette procédure et vous apprendrez également à exclure des parties de la base de code du reformatage à l'aide de divers raccourcis clavier.

Avantages du reformatage

Il est important de se rappeler qu’aucun code de formatage ou de commentaire n’est requis pour que la fonction fonctionne. Tout code, avec ou sans formatage, peut être entièrement lu et exécuté par le compilateur. D’un autre côté, le reformatage rend le balisage beaucoup plus facile à lire. Pour le compilateur, tout ce qui compte c'est que le code fonctionne et qu'il ne contienne pas d'erreurs, et non pas sa qualité ou sa belle indentation. Certes, c'est ce dernier qui inquiète les gens, car ils doivent lire un tel code. Tout comme pour le texte brut, personne n’aime lire du contenu informel sans titres, paragraphes ou indentation. Certaines des techniques de reformatage nécessaires incluent :

• Retrait.
• Fonctions de style et d'écriture.
• Espace libre.
• Utilisation de lettres majuscules et de noms.

Le débogage est un mal nécessaire qu’un développeur rencontrera fréquemment tout au long de sa carrière. Par où commencer si votre base de code est encombrée et désorganisée ? Lorsque le code source est correctement formaté et mis en retrait, il apparaît moins groupé. Cela permet de déterminer plus facilement où se trouvent les différents modules applicatifs. Par conséquent, il devient plus facile de trouver des problèmes et des erreurs. Le reformatage du code dans IntelliJ IDEA est basé sur les exigences spécifiées dans les paramètres de style de code dans l'EDI. Cependant, lorsque vous utilisez EditorConfig dans votre projet, les paramètres que vous spécifiez dans le fichier .editorconfig remplaceront par défaut ceux spécifiés dans les paramètres de style de code. Le reformatage dans IntelliJ n'est pas différent du travail dans d'autres IDE. Il existe des options pour reformater à la fois un seul bloc de code et l'intégralité du fichier. Il peut arriver que l'intégralité de votre bloc de code soit assez longue et que vous souhaitiez que tout soit reformaté, à l'exception de quelques zones spécifiques. Dans ce cas, choisir individuellement les parties du code que vous souhaitez formater n’est certainement pas la meilleure option. Dans de telles situations, le reformatage avec IntelliJ sera certainement utile. Nous explorerons cela ainsi que d’autres utilisations de l’EDI.

Conseils pour formater le code

Examinons quelques conseils de base pour le formatage du code en général :

• Assurez-vous que votre code est correctement commenté. Utilisez des commentaires pour transmettre l’intention et le sens. Même si vous êtes le seul à lire ce code, il est quand même utile de rappeler la fonction de certains blocs de code. Cela facilitera les choses si vous revenez à votre base de code après des vacances, par exemple.

• N'utilisez pas de tabulations pour les espaces sur la même ligne. Cela réduit la lisibilité du code.

• Ajoutez un TODO à vos blocs de code pour suivre les futures implémentations. De cette façon, lorsque vous reformaterez votre code, cela ne créera pas l’illusion que votre travail est terminé.

• N'utilisez pas le reformatage du code comme solution rapide aux erreurs de syntaxe.

• Évitez les investissements importants. Il s'agit d'une pratique courante chez certains développeurs, mais le code profondément imbriqué rend la lecture difficile et introduit des erreurs qui ne sont pas faciles à repérer au premier coup d'œil.

Reformatage du code dans IntelliJ IDEA

Avant d'explorer différentes façons de formater le code dans IntelliJ, commencez par créer un exemple de projet Java dans votre IDE. Une fois que vous lancez IntelliJ, vous devriez voir un écran comme celui-ci : Cliquez sur Suivant et terminez la configuration d'initialisation du projet. Maintenant que votre projet est configuré, il est temps d'ajouter un exemple de code pour vous aider à comprendre le reformatage du code dans IntelliJ. Il s'agit d'un simple compteur de mots de l'Université du Texas :

import java.io.File;
import java.io.IOException;
import java.util.Map;
import java.util.Scanner;
import java.util.TreeMap;

public class SimpleWordCounter {

    public static void main(String[] args) {
        try {
            File f = new File("ciaFactBook2008.txt");
            Scanner sc;
            sc = new Scanner(f);
            // sc.useDelimiter("[^a-zA-Z']+");
            Map<String, Integer> wordCount = new TreeMap<String, Integer>();
            while(sc.hasNext()) {
                String word = sc.next();
                if(!wordCount.containsKey(word))
                    wordCount.put(word, 1);
                else
                    wordCount.put(word, wordCount.get(word) + 1);
            }

            // show results
            for(String word : wordCount.keySet())
                System.out.println(word + " " + wordCount.get(word));
            System.out.println(wordCount.size());
        }
        catch(IOException e) {
            System.out.println("Unable to read from file.");
        }
    }
}

Reformatage d'extraits de code

Commençons par formater les extraits de code. Pour ce faire, mettez simplement en surbrillance la partie du code que vous souhaitez formater et cliquez sur Code > Reformater le code . Comme vous pouvez le constater, la partie en surbrillance de votre code (dans ce cas, les lignes 11 à 17) est correctement formatée. Regardons « avant » et « après » du reformatage de notre extrait de code. Si vous l'avez remarqué dans la première image, la déclaration et l'initialisation de votre variable se sont produites sur la même ligne que try . Les accolades fermantes sont mélangées au bloc else . Mais après avoir mis en évidence cette partie de votre code et utilisé l’option de reformatage, vous vous retrouverez avec un bloc de code plus agréable à l’œil. Le code complet de votre classe ressemble maintenant à ceci : Notez que seul le bloc de code que vous avez sélectionné a été reformaté.

Reformatage de fichiers entiers

Pour reformater l'intégralité du fichier, ouvrez l'éditeur, placez le curseur n'importe où et cliquez sur Code >Reformat File . Vous serez invité à sélectionner les options de reformatage appropriées pour l'ensemble du fichier. Cette action reformatera tout votre code dans l'éditeur actif. Votre code deviendra quelque chose comme ceci :

Reformatage d'un module ou d'un répertoire

Pour ce faire, il vous suffit de cliquer avec le bouton droit sur le module dans la fenêtre des outils du projet et de sélectionner Reformater le code . Dans la fenêtre contextuelle, sélectionnez l'une des trois options dont vous avez besoin :

• Optimiser les importations : sélectionnez cette option si vous souhaitez ajouter des instructions d'importation manquantes et également vous débarrasser des importations inutilisées.

• Réorganiser les entrées : Pour réorganiser le code selon les règles de disposition spécifiées dans les paramètres de style de code.

• Code de nettoyage : pour exécuter le nettoyage du code.

Lorsque vous avez terminé, cliquez simplement sur OK.

Exclure le code du reformatage

Voyons quoi faire si vous avez un bloc de code que vous ne souhaitez pas inclure lors du formatage de l'intégralité du fichier. Accédez à Fichier > Paramètres ou utilisez le raccourci clavier Ctrl + Alt + S. Accédez à Éditeur > Style de code et cochez Activer les marqueurs du formateur dans le menu des commentaires de l' onglet Contrôle du formateur . Dans votre éditeur, créez une ligne de commentaire et tapez //@formatter:off sans guillemets au début de la zone que vous souhaitez exclure. À la fin de la zone, créez une autre ligne de commentaire et saisissez //@formatter:on , également sans guillemets. Dans l'image ci-dessus, vous pouvez voir que le formateur ignorera votre code à la ligne 23 simplement parce que vous l'avez spécifié dans les commentaires et le contrôleur de format.

Exemples de raccourcis clavier pour le reformatage

• Reformater le bloc de code : Ctrl + Alt + Maj + L
• Reformater le fichier : Ctrl + Alt + L
• Ajouter un commentaire à la ligne : Ctrl + /
• Ajouter un commentaire de bloc : Ctrl + Maj + /

Conclusion

Prêter attention aux formats de code est tout aussi important pour un développeur que de le faire fonctionner. Vous ne pouvez jamais savoir qui finira par travailler sur votre code. Avoir une base de code facile à lire et bien structurée témoigne d'un développeur professionnel. Avec IntelliJ IDEA, le formatage de votre code ne doit pas être aussi difficile que l'écriture du code lui-même. La prochaine fois que vous écrirez du code à l’aide d’IntelliJ, utilisez ces conseils. Cela vous facilitera la vie lors du débogage de votre code.