Wikini

DocumentationDuCodePHP

PagePrincipale :: DerniersChangements :: DerniersCommentaires :: ParametresUtilisateur :: Vous êtes ec2-3-133-160-156.us-east-2.compute.amazonaws.com

Besoin


Je débute php. J'aimerais si possible que chaque fichier donne lieu à une phpDoc où seraient décrites les fonctions définies et utilisables pour le développement d'action. Merci -- FidelioEspoir

Il est vrai que le code source de WikiNi manque cruellement de documentation. Il est aussi vrai que cette documentation serait utile pour les nouveaux développeurs de WikiNi. Et il est aussi vrai que relire tout le code source et le commenter à la phpDoc prendrait beaucoup de temp et que ce n'est pas passionant. Conclusion, il est peu probable que cela soit fait dans un avenir proche malheureusement.
--GarfieldFr

Proposition : Faire ici, un groupe de pages, une page par dossier, par fichier, AMHA une page par fonction serait trop long à manipuler, que chacun pourrait documenter. Je peux commencer, mais, étant novice-php, il faudra bien que chacun complète ! Pour que cette aide soit fonctionnelle, il suffirait ;-) que chaque début de script contienne l'URL de la page. Sur Mac+SubEthaEdit? (où je lis les scripts) je peux en commande-cliquant sur l'url, y aller directement. On aurait une doc toujours à jour, facile d'accès et dont la charge se répartirait sur tous... Qu'en penses-tu ? Qu'en pensez-vous ? J'essaye ?
Naturellement, je serai très heureux si tu créais une wikini-action me permettant d'assimiler php en faisant ces pages ;-o)))
-- FidelioEspoir

L'idée de faire une ou plusieurs pages de documentation du code source est certainement interressante, mais je pense qu'il est plus interressant de commenter directement le code source car lorsque on doit faire une modification on a la documentation sous les yeux. Par contre, il faudrait rédiger cette documentation de manière à générer une documentation HTML via des outils tel que phpDoc. --GarfieldFr


Références


Il n'y a pas de commentaire sur cette page. [Afficher commentaires/formulaire]