Discussion :

[debutanteVB.NET]

Bonjour,

Ma question va sembler un peu "bête" mais voilà, j'ai l'habitude de programmer dans d'autres languages plus objets que php... et du coup je ne sais pas trop comment faire la doc.
tout ce qui est diagramme de classe, de séquence etc.
Comment puis je mettre en valeur les fichiers importants, le liens entre ceux ci etc.
Pour le moment, j'ai mes cas d'utilisation, mes quelques classes en diagramme de classe, l'architecture de ma bdd mais j'ai dû mal à voir commment faire pour que celui qui vienne derrière sache comment reprendre le site.
Avez vous des idées? des exemples? comment faites vous?

Merci d'avance à tous

[SirDarken]

Bah je dirai simplement :

Commentaires en entêtes de chaque page, précisant son but, et le déroulement général.
Commentaires en debut de chaque fonction pour les pages de fonctions, expliquant la syntaxe,le déroulement.
Commentaires à coté des lignes que j'estime importantes, ou bien avant un traitement assez long (//Debut process machin ..... //Fin process machin)

Aprés je fait pas trop d'objet en php, mais tu peux pourquoi pas ajouter un doc pdf de tes études (UML ?), voir du cachier des charges.

Je pense que c'est surtout un choix à faire et qu'ensuite il faut suivre tout le long de ton stage/job , la personne te suivant une fois ton système compris sera à l'aise, si parcontre tu change à chaque developpement ca peut faire mal à ton suivant, je te le garanti même ayant ce problème justement, la personne que je remplace changer ca façon de faire à chaque appli, même au niveau incrémentation de la syntax une vraie misère.

Aprés je sais pas si il existe des règles précises, ou des logiciels assurant un suivi, j'ai pas assez vécu ^^.

[debutanteVB.NET]

Ok merci

En fait, je dois faire la doc d'une application que j'ai repris, dans ce qui est à moi, j'ai ajouté pas mal de commentaires; mais là on me demande de faire une doc technique (et on me donne pratiquement un mois donc j'ai de quoi la faire niquelle).
Je suis entrain d'expliquer justement le but de chaque fichier.php
Mon prédécesseur avait commencé à faire un fichier excel (pourquoi ce choix j'en sais rien) avec chaque fichier quels liens sur les autres fichiers, quels classes utilisés, quelles fonctions.. mais c'est un peu l'usine à gaze et pas très lisible. Je ne sais pas comment bien representer un diagramme de séquence (il y a 100 pages php environs au total).


Je suis d'accord sur le fait que des commentaires dans le code c'est indispensable, mais pour rentrer dans le code, rien ne vaut une petite intro de l'architecture, des choix pris, des astuces pour changer par exemple de bdd (quel fichier modifier etc)...

Ca ne se fait pas de la doc en php?

[SirDarken]

Personnelement je ne connais pas assez ce sujet.
Mais rien ne t'empeche de réaliser un plan sur Visio ou bien toute autre logiciel d'études comme rationnal rose (il doit exister des solutions gratuites).

Je me servais de Rationnal Rose en stage et on y faisait totues l'études UML (avec Diagrammes de classes ect ect mais je perd un peu la mémoire).
Tu y fait tes schémas, tu les copie dans un doc ou un pdf

http://uml.developpez.com/outils/ pour les outils UML enfin si c'est ce que tu recherche.

Aprés il ne reste plus qua attendre qu'une personne en sachant plus passe par ici.