AccueilAccueil  CalendrierCalendrier  FAQFAQ  RechercherRechercher  MembresMembres  GroupesGroupes  S'enregistrerS'enregistrer  ConnexionConnexion  

Documentation de code PHP

Documentation de code PHP  posté le :
Salut,

Voilà ça fait depuis 2 jours que je cherche comment documenter son code PHP sans passer par un générateur de documentation et je trouvent toujours rien.

Es-ce que quelqu'un serait comment faire ?
(attention je parle bien de documenter, pas de commenter avec // et /* */)

Merci d'avance pour vos réponses.
loulou123546
avatar
Codeur VeryActif
Messages : 50
Coda'Points : 484
Date d'inscription : 04/06/2016

Niveau en programmation
HTML/CSS:
1/3  (1/3)

Re: Documentation de code PHP  posté le :
Coucou Smile

Qu'entends-tu par documenter un code PHP ? Smile.
Tu veux dire, faire une description d'API ? Genre : https://laravel.com/api/5.2/
Eluknow
avatar
Administrateur
Messages : 2185
Coda'Points : 3896
Date d'inscription : 29/08/2013

Niveau en programmation
HTML/CSS:
3/3  (3/3)

Re: Documentation de code PHP  posté le :
Non, par exemple documenter des fonctions (ce quel prennent comme argument, courte description de leur utilisation)

un exemple avec visual studio code

Ma fonction :


Avec une fonction officiel :


Et si on clique sur la petite icone (i) :
loulou123546
avatar
Codeur VeryActif
Messages : 50
Coda'Points : 484
Date d'inscription : 04/06/2016

Niveau en programmation
HTML/CSS:
1/3  (1/3)

Re: Documentation de code PHP  posté le :
Oula, je ne suis pas bien sûr que ce soit possible...
Tu codes avec quel éditeur ? C'est Coda2 ? Atom ? PHPStorm ? J'ai Atom et PHPStorm, je peux regarder. Mais il me semble que ce n'est pas possible, à moins qu'il y ait un fichier dans le logiciel en lui même qui permettent de définir tes propres fonctions comme un peu les snippets et les personnalisations possibles dans les fichiers de config dans Sublime Text 2.

En tout cas, si c'est possible, il faut que tu te renseignes sur le site web du logiciel en question Wink
Eluknow
avatar
Administrateur
Messages : 2185
Coda'Points : 3896
Date d'inscription : 29/08/2013

Niveau en programmation
HTML/CSS:
3/3  (3/3)

Re: Documentation de code PHP  posté le :
C'est Visual studio code (design sympa, compatible Windows,linux et mac, intégration de git, Parfait !)

Je sais pas car avec notepad++ j’obtiens ça :
loulou123546
avatar
Codeur VeryActif
Messages : 50
Coda'Points : 484
Date d'inscription : 04/06/2016

Niveau en programmation
HTML/CSS:
1/3  (1/3)

Re: Documentation de code PHP  posté le :
Bon j'ai chercher est effectivement ce sont des snippets écrit en json qui gére l'ensemeble des fonction par langage.
du coup j'ai ajouté les miennes.
je te laisse fermer le sujet.
loulou123546
avatar
Codeur VeryActif
Messages : 50
Coda'Points : 484
Date d'inscription : 04/06/2016

Niveau en programmation
HTML/CSS:
1/3  (1/3)

Re: Documentation de code PHP  posté le :
Ahah, ça marche Wink. J'archive alors!
Eluknow
avatar
Administrateur
Messages : 2185
Coda'Points : 3896
Date d'inscription : 29/08/2013

Niveau en programmation
HTML/CSS:
3/3  (3/3)

Re: Documentation de code PHP  posté le :
Contenu sponsorisé


Page 1 sur 1

Permission de ce forum:Vous ne pouvez pas répondre aux sujets dans ce forum
A Toi de Coder - Forum de codage :: Corbeille :: Corbeille du forum-
Sauter vers: