Salut,
Juste une remarque au sujet des commentaires et documentations; En cours on nous dit qu'il faut tout commenter et tout documenter, mais c'est faux !
Il vaut mieux mille fois utiliser des variables parlantes, et ne commenter que ce qui mérite explication, en s'adressant à un développeur ( ce n'est pas une personne incompétente qui va lire le code source de toute manière ).
Il faut attacher plus d'importance à la qualité et la lisibilité du _CODE_ plutôt que de faire du code illisible et d'espérer qu'un commentaire va sauver le coup en "expliquant" ce qu'un bout de code incompréhensible fait; Ca ne change rien ou pas grand chose au fait que si quelqu'un doit reprendre le travail derrière, il devra quand même comprendre le fonctionnement du code en lui même.
La documentation, c'est un peu pareil; Documenter techniquement une application en long en large et en travers, c'est bien beau, mais ça ajoute beaucoup de contraintes; Une modification sur l'application doit également se répercuter sur la doc, et en général ça fait perdre beaucoup de temps. J'ai été confronté à beaucoup de projets où une doc existait au préalable, mais vu que les délais pour les maintenances évolutives ou correctives étaient courts, ça ne laissait pas le temps au développeurs de modifier les documentations, ce qui les rend obsolètes, et même dangereuses !
En gros, avec l'expérience que j'ai acquise, voila ce que j'en pense : les commentaires doivent être purement fonctionnels, le code doit être lisible et compréhensible facilement par un autre développeur ( vive l'orienté objet ! ) et la documentation doit être facilement modifiable et pas trop abondante pour permettre à un développeur de rapidement la modifier si cela s'avère nécessaire.
A+
Partager