Skip to content

Bonnes pratiques et Linter du groupe

Arthur Schamroth edited this page Dec 1, 2021 · 2 revisions

Linters Utilisés

Nous utilisons le Linter "Lint Check" directement implémenté à Android Studio, qui nous permet de facilement visualiser des erreurs de syntaxe, des warnings lors de la compilation de l'application, ... .
Ce Linter nous permet également de simplifier notre code lorsque celui-ci peut être simplifié.
Voici un exemple de situation où notre code peut être plus facilement lisible et ainsi nous permet d'éviter des erreurs de relecture.
Dans cet exemple, nous testons un formulaire pour tester que tous les champs soient correctement complétés (ici il ne s'agit que de simples vérification de champs non vides), ces tests se font au moyen d'une multitude de else if, rendant le code lourd et redondant.

image

En faisant un simple clic droit sur la première condition, voici ce que le Linter nous propose :

image

Et voici le résultat obtenu après avoir accepté la proposition du Linter :

image

Nous utilisons également un linter dans le workflow Github, celui vérifie une seconde fois le code afin que nous n'ayons pas d'erreur de syntaxe ou d'erreur de compilation, voici une partie de ce que Linter Github nous donne lors d'un merge d'une branche quelconque vers la main.

image

Bonnes pratiques

En ce qui concerne les bonnes pratiques mises en place par le groupe, nous essayons toujours de donner des noms de variables compréhensibles pour tous les membres du groupe.
Nous essayons de commenter un minimum certaines parties de code afin que lorsque quelqu'un d'autre devra utiliser cette partie de code il puisse s'y retrouver sans trop de difficulté.
Nous avons décidé assez tardivement de déclarer un maximum de nos variables en anglais afin d'avoir un code en une seule langue, ce qui n'était pas le cas jusqu'à maintenant.
Voici un exemple de code :

image

Clone this wiki locally