Info sur JMRI:
Outils de Développement
Structure
Techniques et Standards
Comment Faire
Infos Fonctionnelles
Contexte Infos

JMRI: Pratiques Recommandées

Voici la page d'infos diverses et des pointeurs pour les développeurs JMRI.

Class Library Preferences

Format du Code

Les Conventions Code Java pour les noms, mise en forme, etc sont vraiment utiles. Si vous trouvez que vous ne pouvez pas lire un morceau de code, ceux-ci vous aideront à mieux faire.

Notez que nous avons quelques conventions locales au-delà de celles qui sont dans les recommandations Java. Vous les trouverez sur d'autres pages dans cette section, mais par exemple, nous recommendons que vous définissiez le référence de journalisation en bas de chaque fichier.

Code Obsolète

Comme le développement se poursuit, parfois d'anciennes façons de faire les choses doivent être remplacées par de nouvelles façons. Dans de nombreux cas, vous pouvez simplement changer tout le code utilisé dans votre répertoire et avancer. Pour les interfaces générales qui pourraient être utilisés à l'extérieur de JMRI, comme dans les scripts et les CATS, il peut être bon de laisser l'ancienne interface en place pendant un certain temps, en la marquant comme "obsolète" de sorte que les gens peuvent découvrir qu'elle finira par disparaître. Après un nombre suffisant de cycles de parution, l'Interface obsolète peut alors être retirée.

Notez que l'interface obsolète est destinée à travailler encore. Obsolète devrait seulement dire que vous ne pouvez pas compter sur l'interface obsolète pour travailler à l'avenir, de sorte qu'il serait bon de coder ailleurs, pendant que ça fonctionne toujours.

Vous pouvez travailler avec les contrôles relatifs à l'obsolescence "on" lors de la compilation. Pour ce faire, changez cette ligne de build.xml: <property name="deprecation" value="on" /> Cela vous permet d'être attentif aux nouveaux avertissements de désapprobation quand vous codez.

Il existe deux formes pour marquer quelque chose comme obsolète (tag Javadoc et Annotation), et tous deux vous permettent d'ajouter des informations supplémentaires. Une belle discussion des techniques est ici. Nous les utilisons de cette façon: * @ Deprecated 2.7.8 @ Deprecated // 2.7.8 où la ligne contenant la version dans laquelle la dévalorisation est appliquée. Cela vous permet de savoir facilement depuis combien de temps elle a été désapprouvée.