Changes between Version 1 and Version 2 of Fr:DevelopersGuide/StyleGuide


Ignore:
Timestamp:
2022-08-15T17:33:16+02:00 (2 years ago)
Author:
leni
Comment:

adjusted to 37 : remplacer {{{ par ` ; http par https

Legend:

Unmodified
Added
Removed
Modified

  • Fr:DevelopersGuide/StyleGuide

    v1 v2  
    1 [[TranslatedPages(revision=36)]]
     1[[TranslatedPages(revision=37)]]
    22= Lignes directrices pour le développement =
    33
    … …  
    88
    99 * Assurez-vous que le code est compatible avec Java 8.
    10  * '''Documentez''' votre code en utilisant les commentaires en ligne et javadoc. De nombreuses personnes vous en remercieront :) :)
     10 * **Documentez** votre code en utilisant les commentaires en ligne et javadoc. De nombreuses personnes vous en remercieront :) :)
    1111 * Essayez d’éviter les champs publics.
    1212 * JOSM a beaucoup de méthodes d’aide dans les classes `Utils`, `GuiUtils`, `Geometry` ... utilisez-les si vous en avez besoin.
    … …  
    2828 * N'utilisez pas plusieurs lignes vides consécutives.
    2929 * JOSM utilise une indentation de 4 caractères et aucun arrêt de tabulation. Si vous utilisez Notepad++, vous pouvez changer l'indentation par défaut dans les “Préférences” -> “Langue” -> “Paramètres de tabulation” -> cocher “Remplacer par des espaces” (ceci est permanent) ou avec le bouton “changer les paramètres d'indentation” dans la barre d'outils (ceci est un paramètre temporaire et nécessite le greffon "Customize Toolbar").
    30  * ajouter des crochets pour chaque {{{if}}}, sauf s'il est suivi de {{{return}}} (ou peut-être {{{throw}}}).
    31  * Vous devriez utiliser '''checkstyle''' avant le patch/commit : `ant checkstyle` et vérifiez `checkstyle-josm.xml`; si vous trouvez que l'exécution de checkstyle est lente pour tous les fichiers, exécutez-la uniquement pour les fichiers modifiés :
     30 * ajouter des crochets pour chaque `if`, sauf s'il est suivi de `return` (ou peut-être `throw`).
     31 * Vous devriez utiliser **checkstyle** avant le patch/commit : `ant checkstyle` et vérifiez `checkstyle-josm.xml`; si vous trouvez que l'exécution de checkstyle est lente pour tous les fichiers, exécutez-la uniquement pour les fichiers modifiés :
    3232{{{
    3333  #!bash
    … …  
    4646== À quoi devrait ressembler votre javadoc ==
    4747 * Le [http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#styleguide guide de style de Javadoc d'Oracle ] est utilisé comme base pour ce guide.
    48  * {{{@since}}} est utilisé pour les classes et méthodes publiques (visibles par les développeurs de greffons) avec la révision JOSM qui a introduit l'élément. Par exemple : {{{@since 5408}}}.
    49    * {{{@since}}} est mis à jour / ajouté lorsqu'une signature de méthode publique change ou si une classe est renommée.
    50    * {{{@since}}} peut être omis pour les méthodes et champs publics introduits en même temps que la classe, à condition qu'ils n'aient pas été modifiés et que la classe soit correctement documentée.
    51    * Il peut y avoir plusieurs attributs {{{@since}}} - par exemple pour ajouter des interfaces à une classe. Le motif de ces attributs doit être ajouté, par exemple : {{{@since 12345 @FunctionalIterface was added}}}
    52    * Si vous soumettez un patch et que vous ne connaissez pas la révision, ajoutez de toute façon {{{@since xxx}}}. Elle peut ensuite être remplacée lors de la fusion de votre patch.
    53  * {{{@throws}}} est préféré à {{{@exception}}}
     48 * `@since` est utilisé pour les classes et méthodes publiques (visibles par les développeurs de greffons) avec la révision JOSM qui a introduit l'élément. Par exemple : `@since 5408`.
     49   * `@since` est mis à jour / ajouté lorsqu'une signature de méthode publique change ou si une classe est renommée.
     50   * `@since` peut être omis pour les méthodes et champs publics introduits en même temps que la classe, à condition qu'ils n'aient pas été modifiés et que la classe soit correctement documentée.
     51   * Il peut y avoir plusieurs attributs `@since` - par exemple pour ajouter des interfaces à une classe. Le motif de ces attributs doit être ajouté, par exemple : `@since 12345 @FunctionalIterface was added`
     52   * Si vous soumettez un patch et que vous ne connaissez pas la révision, ajoutez de toute façon `@since xxx`. Elle peut ensuite être remplacée lors de la fusion de votre patch.
     53 * `@throws` est préféré à `@exception`
    5454 * vérifiez vos changements avant le patch/commit en générant javadoc : `ant javadoc`, parcourez les messages de sortie ; si vous trouvez que l'exécution de javadoc est lente pour tous les fichiers, exécutez-le uniquement pour les fichiers modifiés :
    5555
    … …  
    7272== Internationalisation ==
    7373
    74  * veillez à utiliser {{{tr(...)}}} pour toutes les chaînes localisées
     74 * veillez à utiliser `tr(...)` pour toutes les chaînes localisées
    7575   {{{
    7676   #!java
    … …  
    8888   }}}
    8989
    90  * n'assemblez jamais les messages localisés avec {{{+}}}. Utilisez plutôt des caractères de remplacement de format à la place.
     90 * n'assemblez jamais les messages localisés avec `+`. Utilisez plutôt des caractères de remplacement de format à la place.
    9191
    92    '''NE FAITES PAS'''
    93    {{{new JLabel(tr("My Label " + labelId));}}}
     92   **NE FAITES PAS**
     93   `new JLabel(tr("My Label " + labelId));`
    9494
    95    '''FAITES'''
    96    {{{new JLabel(tr("My Label {0}",labelId));}}}
     95   **FAITES**
     96   `new JLabel(tr("My Label {0}",labelId));`
    9797
    98    Seule exception : {{{+}}} peut être utilisé pour interrompre de longues lignes de textes non variables.
     98   Seule exception : `+` peut être utilisé pour interrompre de longues lignes de textes non variables.
    9999   Les caractères de remplacement sont obligatoires dans les traductions simples.
    100100
    … …  
    104104   }}}
    105105
    106  * Un contexte de traduction peut être défini avec {{{trc(...)}}}. Des indications supplémentaires pour les traducteurs sont données par les commentaires java de la fonction :
     106 * Un contexte de traduction peut être défini avec `trc(...)`. Des indications supplémentaires pour les traducteurs sont données par les commentaires java de la fonction :
    107107   {{{#!java
    108108   /* I18n: numéro de maison (house number), rue comme paramètre ; placer le numéro en premier pour la lisibilité. */
    … …  
    110110   }}}
    111111
    112  * Utilisez {{{trn(...)}}} pour laisser les traducteurs choisir le pluriel spécifique à la langue :
     112 * Utilisez `trn(...)` pour laisser les traducteurs choisir le pluriel spécifique à la langue :
    113113   {{{#!java
    114114   msg = trn("Object deleted", "Objects deleted", del.size();