01/11/2014, 09:53:37
Salut,
je te rejoins tout a fait ça serait l'idéal en effet ...
je n'ai jamais été très "avenant" avec la doc ...
j'essaye de mettre dans le code quelques commentaire et/ou non de variable et fonction "intelligent" qui veulent dire un peut quelque chose
je ne suis pas sur que commenter l'architecture "technique" serve a tout le monde en tout cas pour les utilisateurs
ceux qui veulent rentrer dans le soft et ajouter des éléments là oui ça aiderai ces personnes là pas sur que cela soit la majorité
perso je n'ai eu aucune doc et suis rentré dans le code au fur et a mesure du temps, l'architecture est a mon avis relativement "simple"
si quelqu'un veux ajouter un widget par exemple il "suffit" de s'inspirer de ceux qui existe et le code reste assez "light" pour chacun
je pourrais décrire en détail les éléments d'un widget ça en intéresserais surement quelques uns
dommage que les journée ne fassent que 24 heures ...
PS : si des amateurs pour faire de la doc je suis preneur
...
voir juste faire quelques vidéos (youtube) de démo sur certains éléments ça peut-être aussi pas mal ...
@+
Anthony.
fma38 a écrit :Concernant la doc, il faudrait avoir au moins quelques grandes lignes, sur les concepts et l'architecture ; c'est toujours difficile de comprendre comme s'articule un soft sans ça. L'idéal serait quelques diagrammes uml avec les objets qui dialoguent entre eux...
Après, le mieux est effectivement de documenter le code, de le rendre le plus clair possible (en évitant les astuces alakon imbittables), en utilisant des noms de variables/méthodes explicites, etc...
je te rejoins tout a fait ça serait l'idéal en effet ...
je n'ai jamais été très "avenant" avec la doc ...
j'essaye de mettre dans le code quelques commentaire et/ou non de variable et fonction "intelligent" qui veulent dire un peut quelque chose
je ne suis pas sur que commenter l'architecture "technique" serve a tout le monde en tout cas pour les utilisateurs
ceux qui veulent rentrer dans le soft et ajouter des éléments là oui ça aiderai ces personnes là pas sur que cela soit la majorité
perso je n'ai eu aucune doc et suis rentré dans le code au fur et a mesure du temps, l'architecture est a mon avis relativement "simple"
si quelqu'un veux ajouter un widget par exemple il "suffit" de s'inspirer de ceux qui existe et le code reste assez "light" pour chacun
je pourrais décrire en détail les éléments d'un widget ça en intéresserais surement quelques uns
dommage que les journée ne fassent que 24 heures ...
PS : si des amateurs pour faire de la doc je suis preneur
...voir juste faire quelques vidéos (youtube) de démo sur certains éléments ça peut-être aussi pas mal ...
@+
Anthony.