Skip to content
This repository has been archived by the owner on Sep 7, 2023. It is now read-only.

Android Studio Comment nettoyer son code

theodoreJordan edited this page May 12, 2021 · 1 revision

Plusieurs règles à suivre lorsqu'on nettoie son code :

  • supprimer les logs inutiles, laisser que ceux qui sont vraiment précis ou utiles, ou qui concernent les erreurs dans le code !

  • laisser un espace entre la déclaration de la classe et des variables/méthodes

  • dans une classe : regrouper les variables par groupe logique, commenter pour expliquer au dessus de chaque variable ou au dessus du bloc

  • respecter une indentation logique en terme de tabulation

  • mettre un espace avant et après chaque boucle ou if, sauf si c'est collé au début ou à la fin du bloc dans lequel la boucle est définie

Exemple :

    for((k,v) in sortedCategoryMap){
        if(k != "*"){
            sortedList.add(k)
            var vSort = listOf<Oeuvre>()
            
            if(filter == "A-Z"){
                vSort = v.sortedWith(compareBy(Oeuvre::title))
            }else{
                vSort = v.sortedWith(compareBy(Oeuvre::distance))
            }
            
            sortedList.addAll(vSort)
        }
    }
  • mettre les commentaires au dessus de la boucle/fonction/variable qu'on explique

  • bien faire attention à supprimer tous les fichiers inutiles, surtout les fichiers qui concernent le visuel, il en va de même avec les variables/fonctions inutiles (sauf si on n'est pas sur)

  • respecter une nomenclature de nom de variables intelligente

  • respecter encore plus la nomenclature des noms de fichiers qui concernent tout le visuel, on se perd rapidement !!

Clone this wiki locally