Est-ce une bonne pratique d'utiliser le formatage automatique du texte?

11

J'utilise Eclipse et je vais en parler à titre d'exemple, mais je suis sûr que c'est le cas dans tout autre IDE.

Eclipse a la commande CTRL- Shift- Fqui formate automatiquement votre code. Est-ce une bonne pratique d'utiliser ce type de formatage? Je demande dans le contexte d'un grand projet dans lequel il peut y avoir de nombreux programmeurs travaillant sur les mêmes fichiers et tous ceux-ci sont administrés par un système CSV.

Je vous remercie!

Ionut
la source

Réponses:

12

Oui, ça l'est.

Eclipse vous permet de définir votre propre style de code exportable que vous pouvez partager entre tous vos développeurs. Si vous ne souhaitez pas configurer votre propre style de mise en forme, vous pouvez demander à vos développeurs d'utiliser la mise en forme par défaut d'Eclipse. Même si vous utilisez celui par défaut, je vous conseillerais de l'exporter et de le mettre sur un lecteur réseau partagé pour que tous les développeurs l'utilisent. Si plus tard, vous décidez de changer une chose, vous pourrez facilement.

Quoi qu'il en soit, je vous conseillerais de commencer le plus tôt possible, le mieux serait au début du projet, et de garder votre code toujours formaté au format choisi. Vous voudrez éviter d'avoir des "validations de format" pures pendant le développement car il est alors difficile de distinguer les validations "réelles". En pratique, cela signifie que les développeurs doivent être rigoureux avec leurs engagements .

Aussi, et je le mets à la fin parce que ce n'est que mon opinion personnelle, mais envisagez de supprimer la limite de 80 caractères par ligne (ou de l'étendre à quelque chose de plus grand, nous avons 120 caractères ici), ce qui est, si je ne me trompe pas, la longueur de ligne de mise en forme automatique par défaut sur Eclipse. Nous avons maintenant tous de grands écrans et de grandes résolutions d'écran, donc ça va. À ce sujet, consultez la limite de 80 caractères toujours pertinente en période de questions et réponses sur les écrans larges, vous pourrez alors prendre votre propre décision.

Edit: Thorbjørn fait un bon point sur la fonctionnalité "Formater chaque fois qu'un fichier est enregistré".

Jalayn
la source
5

Oui, c'est une très bonne pratique. Il assure que tout le monde est d' accord comment les fichiers source doivent regarder lors de l'ouverture dans un éditeur.

De plus, j'ai eu de très bonnes expériences avec la fonctionnalité "Formater chaque fois qu'un fichier est enregistré". (Nous utilisons la configuration standard du formateur Eclipse).

Activez-le en ouvrant les propriétés Eclipse et sélectionnez Java -> Editeur -> Enregistrer les actions. Activez "Effectuer les actions sélectionnées lors de l'enregistrement" et "Formater le code source".

La raison en est naturellement que le code est toujours formaté, vous pouvez donc formater à volonté lors de l'édition sans craindre quoi que ce soit se casse. Cela garantit également que les journaux du référentiel source sont exacts (ce qui est important lors de l'analyse judiciaire).


la source
J'ai oublié ça, bon point.
Jalayn
3

Vous devriez avoir une norme de codage que vous suivez tous. Que cela soit appliqué par des outils externes (tels que le retrait), ou IDE, ou à la main n'a pas d'importance. Ce qui est pertinent, c'est que cela devrait être fait avant la validation.

Sardathrion - contre les abus SE
la source
3

Il est recommandé de suivre une norme de codage bien définie dans un projet / une entreprise. Les moyens de le faire peuvent cependant varier, choisissez simplement ce qui fonctionne le mieux pour votre organisation. Si tout le monde utilise Eclipse, vous pouvez simplement créer un format de code exportable pour vos projets et le répartir entre les développeurs (Eclipse a également une option pour formater automatiquement les fichiers à chaque sauvegarde), mais je recommanderais de créer un document décrivant le format choisi.

devmiles.com
la source