====== Best pratices ======

<WRAP center round important 60%>
Ebauche
</WRAP>


Lorsque l'on code en python sur blender il faut **impérativement** suivre les recommandations officielles de blender, ce qui nous garantis une homogénéité et des performances équivalente entre les différents addons car on peut garantir la même qualité de code.

[[https://docs.blender.org/api/blender_python_api_2_71_6/info_best_practice.html#]]

Ensuite pour l'écriture du code et son élégance on a choisit de suivre les recommandations du PEP8 de python

[[https://www.python.org/dev/peps/pep-0008/]]

Quelques link dans la doc pour rappel.

En matière d'indentation : [[https://www.python.org/dev/peps/pep-0008/#id17]]

Nom de Classe : [[https://www.python.org/dev/peps/pep-0008/#id17]]

Taille de ligne maximum : [[https://www.python.org/dev/peps/pep-0008/#id19]]

Et surtout bien lire celle-là

Les commentaires : [[https://www.python.org/dev/peps/pep-0008/#id30]]

Un bon code c'est surtout :
  * Un code bien aéré, donc agréable à lire
  * Remplis de commentaires pertinent
  * Chaque fonctions ou classes documentées avec des **documentation strings** à l'intérieur afin de pouvoir utiliser les fonctions de python nous permettant de lire le comportement sans parcourir toutes les pages à la recherche de la fonction mentionnée.

Pour toutes question n'hésitez pas à les poser sur le forum [[https://khaganat.net/forum/index.php/topic,553.0.html]].

On préférera toujours des questions "idiotes" que des choses à reprendre après coup.


{{tag>informatique}}