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


Ignore:
Timestamp:
2024-04-20T12:57:33+02:00 (10 months ago)
Author:
DiGro
Comment:

adjusted to revision 38

Legend:

Unmodified
Added
Removed
Modified
  • Nl:DevelopersGuide/StyleGuide

    v15 v16  
    1 [[TranslatedPages(revision=37)]]
     1[[TranslatedPages(revision=38)]]
    22= Richtlijnen voor ontwikkelen =
    33[[PageOutline(2-2,Inhoud,inline)]]
     
    55== Hoe uw code er uit zou moeten zien ==
    66
    7  * zorg er voor dat de code compatibel is met Java 8
     7 * Zorg ervoor dat de code compatibel is met Java 11
    88 * **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.
    1111 * Controleer parameters. U kunt `Objects.requireNonNull` gebruiken.
    12  * Schrijf niet voor de uitvoering - schrijf voor leesbaarheid. Gebruik `Stream`s, `Function`s en andere objecten van Java 8 als dat de code beter leesbaar maakt.
     12 * Schrijf niet voor de uitvoering - schrijf voor leesbaarheid. Gebruik `Stream`s, `Function`s en andere objecten van Java 8+ als dat de code beter leesbaar maakt.
    1313
    1414=== Threading / Vergrendeling ===
    1515
    16  * JOSM gebruikt verschillende mechanismen om te vergendelen, afhankelijk van het object.
    17  * De gegevenssets worden beschermd door een RW-vergendeling. Sommige methoden vergrendelen niet automatisch om redenen van uitvoering. Zorg er voor de vergrendelingen aan te roepen die voor uw wijzigingen nodig zijn.
     16 * JOSM gebruikt verschillende mechanismen om te vergrendelen, afhankelijk van het object.
     17 * De gegevenssets worden beschermd door een RW-vergrendeling. Sommige methoden vergrendelen niet automatisch om redenen van uitvoering. Zorg er voor de vergrendelingen aan te roepen die voor uw wijzigingen nodig zijn.
    1818 * Componenten van de GUI zouden alleen moeten worden aangepast in de EDT-thread
    1919 * Gebruik bij voorkeur `SwingUtils.invokeLater` indien u iets moet uitvoeren in de UI-thread
     
    2222== Hoe uw opmaak eruit zou moeten zien ==
    2323
    24  * zorg er voor dat er geen witruimte achter staat
     24 * zorg ervoor dat er geen witruimte achter staat
    2525 * gebruik niet meerdere lege regels achter elkaar
    26  * 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).)
     26 * JOSM gebruikt 4 tekens voor inspringen en geen tabstops (Als u Notepad++ gebruikt kunt u de standaard inspringing wijzigen in de "Bewerken" -> "Witruimte-bewerkingen" -> selecteer "Tabs 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).)
    2727 * voeg gekrulde haken toe voor elke `if`, tenzij die wordt gevolgd door een `return` (of misschien een `throw`)
    2828 * 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: