petites astuces pour bien coder

Eléphant du PHP | 51 Messages

11 juil. 2007, 13:08

Je n'avais pas pris part au débat car je pense qu'il est utopique et dangereux de vouloir que tout le monde aille dans une même direction.
Personne n'est obligé d'aller dans la même direction
En ce qui concerne l'indentation et les commentaires, je suis d'accord, mais il se pose ensuite la question du "comment"
Pour les tabulations : 4 espaces ou un tab ?
Pour les commentaires : chaque ligne, par bloc, par section compliquée ?
Pour indenter au choix des espaces ou tab franchement je ne vois pas où ca peu gêné que se soit l'un ou l'autre.
Pour les commentaires je dirai par bloc, par ligne se serais trop lourd.
Il y a ceux qui pensent, Il y a ceux qui croient et Il y a ceux qui doutent. Je pense que je crois que je doute. :-k
Image

Avatar du membre
Administrateur PHPfrance
Administrateur PHPfrance | 13231 Messages

11 juil. 2007, 14:05

Pour indenter au choix des espaces ou tab franchement je ne vois pas où ca peu gêné que se soit l'un ou l'autre.
Personnelement, je préfère par tabultation parce que la navigation au clavier est plus facile
Mais la présence de tabulation entraine le risque que différents IDE sous différents plateformes ne rendent pas la même indentation ;)
Pour les commentaires je dirai par bloc, par ligne se serais trop lourd.
C'est discutable ...
Dans certains codes d'interfaces qui ne font qu'appeler des méthodes d'objets, chaque ligne à son importance ...
Dans certains méthodes de parcours de tableau pour afficher le contenu, seul le bloc est nécessaire ;)

PS : au cas où tu ne l'aurais pas compris, je cherche juste à te montrer qu'il ne faut pas être trop précis quand tu détailles des conseils ... sinon personne n'en tiendra compte :lol:
Connaître son ignorance est la meilleure part de la connaissance
Pour un code lisible : n'hésitez pas à sauter des lignes et indenter

twitter - site perso - Github - Zend Certified Engineer

Avatar du membre
Modérateur PHPfrance
Modérateur PHPfrance | 10684 Messages

11 juil. 2007, 14:23

Je suis d'avantage tabulations également... et si c'est vrai que cela peut déranger quand on change d'IDE, la plupart des éditeurs aujourd'hui (les bons du moins ;)) permettent de paramétrer la taille des tabulations pour éviter cela :)

Quant aux commentaires il n'y a pas de règle à la ligne, au bloc ou à la page : l'obejctif est de savoir ce que l'on fait sans avoir à analyser le code. On peut commenter un if() complexe parce qu'il va tester 3 ou 4 critères et on pourra passer sur une 30 de lignes d'affectation de variable en résumant le commentaire à : "// Affectation des variables"

Il y a quelques normes issues de javadoc pour les classes et les fonctions (les commentaires qui débutent par /** au lieu de /*), dont le but est de permettre la génération de la documentation associé et qui facilite leur recherche et leur emploi.

En gros, faut pas que ce soit un roman, faut juste que ce soit simple pour celui qui passera derrière, sachant que ca peut très bien être nous :)
Ce n'est pas en améliorant la bougie que l'on a inventé l'ampoule...