Changes between Version 14 and Version 15 of Nl:DevelopersGuide/StyleGuide


Ignore:
Timestamp:
2022-08-12T17:22:08+02:00 (3 years ago)
Author:
DiGro
Comment:

adjusted to revision 37

Legend:

Unmodified
Added
Removed
Modified

  • Nl:DevelopersGuide/StyleGuide

    v14 v15  
    1 [[TranslatedPages(revision=36)]]
     1[[TranslatedPages(revision=37)]]
    22= Richtlijnen voor ontwikkelen =
    33[[PageOutline(2-2,Inhoud,inline)]]
    … …  
    66
    77 * zorg er voor dat de code compatibel is met Java 8
    8  * '''Documenteer''' uw code met behulp van commentaar op de regel en javadoc. Vele mensen zullen u daarvoor danken :)
     8 * **Documenteer** uw code met behulp van commentaar op de regel en javadoc. Vele mensen zullen u daarvoor danken :)
    99 * Probeer publieke velden te vermijden
    1010 * JOSM heeft heel veel hulpmethoden in de klassen `Utils`, `GuiUtils`, `Geometry` .... Gebruik ze als u ze nodig hebt.
    … …  
    2525 * gebruik niet meerdere lege regels achter elkaar
    2626 * JOSM gebruikt 4 tekens voor inspringen en geen tabstops (Als u Notepad++ gebruikt kunt u de standaard inspringing wijzigen in de "Instellingen" -> "Voorkeuren" -> "Language" -> "Tab settings" -> selecteer "Omzetten in spaties" (dit is permanent) of met de knop "Instellingen insprong wijzigen" in de werkbalk door het vinkje te verwijderen bij "Tabs gebruiken" (dit is een tijdelijke instelling).)
    27  * voeg gekrulde haken toe voor elke {{{if}}}, tenzij die wordt gevolgd door een {{{return}}} (of misschien een {{{throw}}})
    28  * U zou '''checkstyle''' moeten gebruiken vóór patch/commit: `ant checkstyle` en controleer `checkstyle-josm.xml`; indien u vindt dat het uitvoeren van checkstyle te lang duurt voor alle bestanden, voer het dan alleen uit op de gewijzigde bestanden:
     27 * voeg gekrulde haken toe voor elke `if`, tenzij die wordt gevolgd door een `return` (of misschien een `throw`)
     28 * U zou **checkstyle** moeten gebruiken vóór patch/commit: `ant checkstyle` en controleer `checkstyle-josm.xml`; indien u vindt dat het uitvoeren van checkstyle te lang duurt voor alle bestanden, voer het dan alleen uit op de gewijzigde bestanden:
    2929       
    3030{{{
    … …  
    4343== Hoe uw javadoc er uit zou moeten zien ==
    4444 * De [https://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#styleguide Oracle Javadoc style guide] wordt gebruikt als gids voor de basis
    45  * {{{@since}}} wordt gebruikt voor publieke klassen en methoden (zichtbaar voor de ontwikkelaars van invoegtoepassingen) met de revisie van JOSM waarin het element werd geïntroduceerd. Voorbeeld: {{{@since 5408}}}
    46    * {{{@since}}} wordt bijgewerkt / toegevoegd als een handtekening van een publieke methode wijzigt of indien een klasse een andere naam krijgt
    47    * {{{@since}}} kan worden weggelaten voor publieke methoden en velden die tegelijkertijd met de klasse worden geïntroduceerd, vooropgesteld dat zij niet zijn gewijzigd en de klasse juist is gedocumenteerd.
    48    * Er kunnen meerdere tags {{{@since}}} zijn, bijv. voor het toevoegen van interfaces aan een klasse. De reden voor deze tags zou moeten worden toegevoegd. Voorbeeld: {{{@since 12345 @FunctionalIterface werd toegevoegd}}}
    49    * Indien u een patch indient en u weet de revisie niet, voeg dan toch {{{@since xxx}}} toe. Het kan dan worden vervangen bij het samenvoegen van uw patch.
    50  * {{{@throws}}} heeft de voorkeur boven {{{@exception}}}
     45 * `@since` wordt gebruikt voor publieke klassen en methoden (zichtbaar voor de ontwikkelaars van invoegtoepassingen) met de revisie van JOSM waarin het element werd geïntroduceerd. Voorbeeld: `@since 5408`
     46   * `@since` wordt bijgewerkt / toegevoegd als een handtekening van een publieke methode wijzigt of indien een klasse een andere naam krijgt
     47   * `@since` kan worden weggelaten voor publieke methoden en velden die tegelijkertijd met de klasse worden geïntroduceerd, vooropgesteld dat zij niet zijn gewijzigd en de klasse juist is gedocumenteerd.
     48   * Er kunnen meerdere tags `@since` zijn, bijv. voor het toevoegen van interfaces aan een klasse. De reden voor deze tags zou moeten worden toegevoegd. Voorbeeld: `@since 12345 @FunctionalIterface werd toegevoegd`
     49   * Indien u een patch indient en u weet de revisie niet, voeg dan toch `@since xxx` toe. Het kan dan worden vervangen bij het samenvoegen van uw patch.
     50 * `@throws` heeft de voorkeur boven `@exception`
    5151* controleer uw wijzigingen vóór patch/commit door het genereren van javadoc: `ant javadoc`, blader door de uitvoerberichten; indien u vindt dat het uitvoeren van javadoc te lang duurt voor alle bestanden, voer het dan alleen uit op de gewijzigde bestanden:
    5252
    … …  
    6969== Internationalisatie ==
    7070
    71  * zorg er voor dat {{{tr(...)}}} gebruikt voor alle gelokaliseerde tekenreeksen
     71 * zorg er voor dat `tr(...)` gebruikt wordt voor alle gelokaliseerde tekenreeksen
    7272   {{{
    7373   #!java
    … …  
    8585   }}}
    8686
    87  * assembleer gelokaliseerde berichten NOOIT met {{{+}}}. Gebruik in plaats
     87 * assembleer gelokaliseerde berichten NOOIT met `+`. Gebruik in plaats
    8888   daarvan tijdelijke plaatsaanduidingen voor opmaak.
    8989
    9090   '''NIET'''
    91    {{{new JLabel(tr("Mijn label " + labelId));}}}
     91   `new JLabel(tr("Mijn label " + labelId));`
    9292
    9393   '''MAAR'''
    94    {{{new JLabel(tr("Mijn label {0}",labelId));}}}
     94   `new JLabel(tr("Mijn label {0}",labelId));`
    9595
    96    Enige uitzondering: {{{+}}} kan worden gebruikt om lange regels van niet-variabele teksten af te breken.
     96   Enige uitzondering: `+` kan worden gebruikt om lange regels van niet-variabele teksten af te breken.
    9797   De plaatsvervangers zijn verplicht in eenvoudige vertalingen.
    9898
    99  * Bij het gebruiken van een apostrof in de tekenreeks voor de bron, moet die zijn geëscaped door een andere apostrof (Zoals de backslash in C):[[BR]]
     99 * Bij het gebruiken van een apostrof in de tekenreeks voor de bron, moet die zijn geëscapet door een andere apostrof (Zoals de backslash in C):[[BR]]
    100100   {{{#!java
    101101   new JButton(tr("Don''t press me more than {0} times!", n))
    102102   }}}
    103103
    104  * Een context voor een vertaling kan direct worden ingesteld met {{{trc(...)}}}. Aanvullende hints voor vertalers worden gegeven in opmerkingen voor Java bij de functie:
     104 * Een context voor een vertaling kan direct worden ingesteld met `trc(...)`. Aanvullende hints voor vertalers worden gegeven in opmerkingen voor Java bij de functie:
    105105   {{{#!java
    106106   /* I18n: huisnummer, straat als parameter; plaats nummer eerst voor zichtbaarheid */
    … …  
    108108   }}}
    109109
    110  * Gebruik {{{trn(...)}}} om vertalers de taalspecifieke meervoudsvorm te laten kiezen:
     110 * Gebruik `trn(...)` om vertalers de taalspecifieke meervoudsvorm te laten kiezen:
    111111   {{{#!java
    112112   msg = trn("Object deleted", "Objects deleted", del.size();