Java Language Déclarations d'emballage


Exemple

  • Le code source et les commentaires ne doivent généralement pas dépasser 80 caractères par ligne et rarement, voire jamais, 100 caractères par ligne, y compris l'indentation.

    La limite de caractères doit être évaluée au cas par cas. Ce qui compte vraiment, c'est la «densité» sémantique et la lisibilité de la ligne. Rendre les lignes trop longues les rend difficiles à lire; De même, faire des «tentatives héroïques» pour les adapter à 80 colonnes peut aussi les rendre difficiles à lire. La flexibilité décrite ici vise à permettre aux développeurs d’éviter ces extrêmes, et non de maximiser l’utilisation du moniteur immobilier.

  • Les URL ou les exemples de commandes ne doivent pas être encapsulés.

// Ok even though it might exceed max line width when indented.
Error e = isTypeParam
        ? Errors.InvalidRepeatableAnnotationNotApplicable(targetContainerType, on)
        : Errors.InvalidRepeatableAnnotationNotApplicableInContext(targetContainerType));

// Wrapping preferable
String pretty = Stream.of(args)
                      .map(Argument::prettyPrint)
                      .collectors(joining(", "));

// Too strict interpretation of max line width. Readability suffers.
Error e = isTypeParam
        ? Errors.InvalidRepeatableAnnotationNotApplicable(
                targetContainerType, on)
        : Errors.InvalidRepeatableAnnotationNotApplicableInContext(
                targetContainerType);

// Should be wrapped even though it fits within the character limit
String pretty = Stream.of(args).map(Argument::prettyPrint).collectors(joining(", "));
  • L'emballage à un niveau syntaxique supérieur est préférable à l'emballage à un niveau syntaxique inférieur.

  • Il devrait y avoir au plus 1 déclaration par ligne.

  • Une ligne de continuation doit être indentée de l’une des quatre manières suivantes

    • Variante 1 : Avec 8 espaces supplémentaires par rapport à l’indentation de la ligne précédente.
    • Variante 2 : Avec 8 espaces supplémentaires par rapport à la colonne de départ de l'expression enveloppée.
    • Variante 3 : Alignée avec l'expression fraternelle précédente (tant qu'il est clair qu'il s'agit d'une ligne de continuation)
    • Variante 4 : Alignée avec l'appel de méthode précédent dans une expression chaînée.