Ubiquitous Network Wiki

Cette page est en lecture seule. Vous pouvez afficher le texte source, mais ne pourrez pas le modifier. Contactez votre administrateur si vous pensez qu'il s'agit d'une erreur.

====== Nettoyer ======

Pour rendre les documents propres, nous avons automatisé le reformatage avec des outils disponibles gratuitement.

==== Code propre ====

Pour garder le code propre, suivez ce guide (mais ne vous inquiétez pas si vous ne le suivez pas !)

=== Outils ===
  * Nettoyer le code Perl, ... (perltidy)
  * Suivre les meilleures pratiques (perlcritic)
  * Automatiser (tidyall)

=== Installation === 
Cpan minus (cpanm) installe le dernier paquet, mais cela peut entrer en conflit avec le gestionnaire de paquets OS.

<code>
cpanm install Perl::Tidy
cpanm install Perl::Critic
cpanm install Code::TidyAll
</code>

==== Utilisation ====

"TidyAll" automatise le formatage du code (perltidy) et la révision du code (perlcritic).
Dans le dossier du projet, vous trouverez un fichier appelé : **".tidyallrc"** qui contient la configuration actuelle. Consultez-le pour comprendre ce qu'il fait.
\\
\\
Pour simuler le résultat : 
<code>
tidyall -a --check-only 
</code>

Pour le mettre en œuvre (perltidy reformatera les fichiers avec un reformatage inplace, perlcritic examinera le code, mais ne modifiera aucun fichier)

<code>
tidyall -a 
</code>

Et les fichiers sont sauvegardés dans le dossier **".tidyall.d"** (ajoutez-le à vos fichiers ignorés par git, si ce n'est pas déjà fait)

==== Meilleures pratiques actuelles avec Perltidy ==== 
(Peut changer à tout moment : soumettez vos propositions, critiques)
\\
Similaire à arg -pbp (perl best practice), principalement :

  * 4 caractères
  * pas de tabulations
  * Longueur de ligne 0 (