Forum |  HardWare.fr | News | Articles | PC | S'identifier | S'inscrire | Shop Recherche
1519 connectés 

  FORUM HardWare.fr
  Programmation
  PHP

  Commentaire de code ? Auto génération ?

 
 


 Mot :   Pseudo :  
 
Bas de page
Auteur Sujet :

Commentaire de code ? Auto génération ?

n°1777797
Pyksel
Locker fou !
Posté le 26-08-2008 à 16:14:03  profilanswer
 

Salut a tous...
 
Quand on regarde certains codes php on peut souvent voir les même lignes en début de code : prenons l'exemple d'un fichier typo3 ;)

Code :
  1. /***************************************************************
  2. *  Copyright notice
  3. *
  4. *  (c) 1999-2008 Kasper Skaarhoj (kasperYYYY@typo3.com)
  5. *  All rights reserved
  6. *
  7. *  This script is part of the TYPO3 project. The TYPO3 project is
  8. *  free software; you can redistribute it and/or modify
  9. *  it under the terms of the GNU General Public License as published by
  10. *  the Free Software Foundation; either version 2 of the License, or
  11. *  (at your option) any later version.
  12. *
  13. *  The GNU General Public License can be found at
  14. *  http://www.gnu.org/copyleft/gpl.html.
  15. *  A copy is found in the textfile GPL.txt and important notices to the license
  16. *  from the author is found in LICENSE.txt distributed with these scripts.
  17. *
  18. *
  19. *  This script is distributed in the hope that it will be useful,
  20. *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  21. *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22. *  GNU General Public License for more details.
  23. *
  24. *  This copyright notice MUST APPEAR in all copies of the script!
  25. ***************************************************************/
  26. /**
  27. * Login-screen of TYPO3.
  28. *
  29. * $Id: index.php 3633 2008-04-23 11:47:26Z flyguide $
  30. * Revised for TYPO3 3.6 December/2003 by Kasper Skaarhoj
  31. * XHTML compliant
  32. *
  33. * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
  34. */
  35. /**
  36. * [CLASS/FUNCTION INDEX of SCRIPT]
  37. *
  38. *
  39. *
  40. *   87: class SC_index
  41. *  120:     function init()
  42. *  159:     function main()
  43. *  268:     function printContent()
  44. *
  45. *              SECTION: Various functions
  46. *  292:     function makeLoginForm()
  47. *  337:     function makeLogoutForm()
  48. *  379:     function wrapLoginForm($content)
  49. *  438:     function checkRedirect()
  50. *  495:     function makeInterfaceSelectorBox()
  51. *  549:     function makeCopyrightNotice()
  52. *  582:     function makeLoginBoxImage()
  53. *  622:     function makeLoginNews()
  54. *
  55. * TOTAL FUNCTIONS: 11


 
Bon, on a tous reconnus des commentaires de code, mais les questions que je me pose, sont les suivantes :
- L'auteur se tape t'il à la main ces commentaires ?
- Existe t il un logiciel ou editeur qui permettent de les générer automatiquement ?
(que ce soit en en-tête de fichier ou pour decrire des fonctions de classe par exemple...)
- Doxygene par exemple se base sur les commentaires de code pour generer des doc... fait-il l'inverse ? (pourquoi pas vu qu'il "parse" les fichiers...)
 
Bref ceci m'aiderait drolement dans la conception des mes classes et fonctions php (actuellement je m'écris tout à la main ou via des copier/coller...)
 
Merci pour les réponses...  [:l'ours maturin]


---------------
Rien est impossible, il suffit d'y croire !
mood
Publicité
Posté le 26-08-2008 à 16:14:03  profilanswer
 

n°1777825
Marty_McFl​y
Nan hé ho, d'accord?
Posté le 26-08-2008 à 16:45:37  profilanswer
 

Idée: te faire une appli qui fait ça automatiquement ?

Message cité 1 fois

---------------
arg(z) = pi /2 donc z = i, moi je prends pas
n°1777832
Pyksel
Locker fou !
Posté le 26-08-2008 à 16:54:20  profilanswer
 

Marty_McFly a écrit :

Idée: te faire une appli qui fait ça automatiquement ?


 
J'y ai pensé à un moment donné, mais bon, si ca existe, pourquoi ré-inventer la roue... Et t'imagine l'appli ? (bon ok, suffit de mettre un morceau au debut du fichier, parser les classe, function, etc...
 
it's possible, mais pas forcément utile de s'attarder dessus...
 
 


Message édité par Pyksel le 26-08-2008 à 16:55:00

---------------
Rien est impossible, il suffit d'y croire !
n°1777837
skeye
Posté le 26-08-2008 à 16:56:43  profilanswer
 

Ton IDE devrait savoir faire ça...

 

[edit]

 

ça se fait à la création du fichier, par contre, en général...


Message édité par skeye le 26-08-2008 à 16:57:14

---------------
Can't buy what I want because it's free -
n°1777853
Pyksel
Locker fou !
Posté le 26-08-2008 à 17:11:29  profilanswer
 

J'utilise dreamweaver CS3... evidement je peux réutiliser les fragments de code, mais un logiciel qui parse les fichiers ca peut être pas mal utile... Pour commenter au mieux le code source. (j'ai l'impression de m'enliser là ;))

Message cité 1 fois

---------------
Rien est impossible, il suffit d'y croire !
n°1778410
grosbin
OR die;
Posté le 27-08-2008 à 16:36:41  profilanswer
 

phpEd permet de le faire, notamment :D
et de surcroit retrace l'arborescence des fichiers dans ton projet, retrace où sont placées tes fonctions,classes,variables et un tas d'autre choses :)


Message édité par grosbin le 27-08-2008 à 16:37:57

---------------
Photos Panoramiques Montagnes Haute Savoie
n°1778686
Profil sup​primé
Posté le 27-08-2008 à 22:44:57  answer
 

Pyksel a écrit :

J'utilise dreamweaver CS3... evidement je peux réutiliser les fragments de code, mais un logiciel qui parse les fichiers ca peut être pas mal utile... Pour commenter au mieux le code source. (j'ai l'impression de m'enliser là ;))


 
lôÔôl c'est pas l'idéal pour le PHP, PHPEdit powaa  ;)  

Message cité 1 fois
n°1778732
Pyksel
Locker fou !
Posté le 27-08-2008 à 23:26:33  profilanswer
 


 
Disons que dreamweaver me depanne pas mal... j'aime bien finalement même si pas aussi complet que zend studio pour le php...


---------------
Rien est impossible, il suffit d'y croire !
n°1778743
Profil sup​primé
Posté le 27-08-2008 à 23:30:01  answer
 

de toute façon, moi, quand il y a de la coloration syntaxique... :)

Message cité 1 fois
n°1778746
Pyksel
Locker fou !
Posté le 27-08-2008 à 23:33:16  profilanswer
 


 
Pour ca que je l'apprécie finalement ;)


---------------
Rien est impossible, il suffit d'y croire !
mood
Publicité
Posté le 27-08-2008 à 23:33:16  profilanswer
 

n°1779530
NewsletTux
&lt;Insérez ici votre vie /&gt;
Posté le 29-08-2008 à 00:35:18  profilanswer
 

J'avais trouvé la PHPDoc, une sorte d'équivalent de la Javadoc, mais je n'ai pas bcp testé ...
http://www.phpdoc.de/


---------------
NewsletTux - outil de mailing list en PHP MySQL

Aller à :
Ajouter une réponse
  FORUM HardWare.fr
  Programmation
  PHP

  Commentaire de code ? Auto génération ?

 

Sujets relatifs
Execution a l ouverture d'un classeur (pas auto_open)[resolu]souci dans mon code php..
xmlhttprequest - problème pour inclure un bout de codedéporter mon code CSS
Génération d'IPUn code compact, optimisé et joli ?
systeme de sondage oui/non + fenetre pour commentaire ?Code pour ouvrir 1 page avec la page racine?
auto clic avec timmmer de 5 secondesmettre beaucoup de code dans un innerhtml
Plus de sujets relatifs à : Commentaire de code ? Auto génération ?

Forum MesDiscussions.Net, Version 2010.2
(c) 2000-2011 Doctissimo
Page générée en 0.047 secondes

Copyright © 1997-2022 Hardware.fr SARL (Signaler un contenu illicite / Données personnelles) / Groupe LDLC / Shop HFR