Nouveau sujet Répondre Imprimer Syndication RSS 2.0

Suggestion Chiante

Documentation du code...
Volcan
Avatar de Talus
  • Age : 20 ans
  • Messages : 1552
  • Inscrit : 28 Septembre 2006
  Lien vers ce message 06 Septembre 2007, 15:47
Plop !

A force d'analyser le code FSB2, je trouve qu'il serait beaucoup plus pratique de faire une documentation du code au style PHPDocumentor (comme le fait phpBB, par exemple), plutôt qu'un Wiki, qui lui, détaille plutôt l'utilisation du code.

Poruquoi ? Comme ca, on a une documentation précise de chaque fonctions / class / methodes / ¨propriétés et leur différentes liaisons, et ca nous évite de devoir chercher dans le wiki toutes les infos sur comment utiliser telle ou telle particularités du code, et ce, juste ne changeant la syntaxe des commentaires de ceux-ci dans le code. Comme celui-ci est plutôt avancé (dans le sens ou y'a pas mal de trucs), c'est là que vient le terme "chiant" pour la suggestion (je l'ai essayé, pour un code moins important, et c'était plutôt... chiant =D).

C'est fait à l'aide du logiciel PHPDocumentor, et après, je trouve que ca rend bien. Vous pouvez me chasser à coup de balai si vous le voulez, mais voilà, ma suggestion chiante est postée =D


 
Chef du projet FSB
Avatar de Genova
  • Age : 22 ans
  • Messages : 14520
  • Inscrit : 16 Septembre 2004
  Lien vers ce message 06 Septembre 2007, 15:47
Trop de modif à faire, pour une utilisation assez limite je trouve.


Cause Im as free as a bird now, And this bird you can not change. - Freebird - Lynyrd Skynyrd
There's someone in my head but it's not me. - Brain damage - Pink Floyd
I said baby, you know Im gonna leave you. - Babe I'm gonna leave you - Led Zeppelin
Father ? yes son, I want to kill you - The end - The Doors
 
Volcan
Avatar de Talus
  • Age : 20 ans
  • Messages : 1552
  • Inscrit : 28 Septembre 2006
  Lien vers ce message 06 Septembre 2007, 15:53
Moui ce serait plus pour ceux qui font les mods en gros... 'Fin bref, c'est chiant à le faire, je le sais bien =D

(Au pire, engager un toutou pour tout faire xD)


 
Equipe des MODS
Avatar de Grummfy
  • Age : 23 ans
  • Messages : 5469
  • Inscrit : 16 Septembre 2004
  Lien vers ce message 06 Septembre 2007, 16:30
déjà suggéré il y a longtemps,
geno m'as dit non...

il trouvait cela trop compliqué à mettre en place ...
alors que une doc est si simple à consulter


"La gravité est le bonheur des imbéciles" Charles de Montesquieu > "T'as raison, L'apesanteur c'est plus rigolo" Hébus de Phalompe (Troll de Troy)
http://www.grummfy.com/download/crea/smileys/fsb2.gif Mods fsb1 - Mods fsb2 - Mon forum - Grummfy's project
 
Chef du projet FSB
Avatar de Genova
  • Age : 22 ans
  • Messages : 14520
  • Inscrit : 16 Septembre 2004
  Lien vers ce message 06 Septembre 2007, 17:17
Ok, lorsque la RC5 sortira je vous laisserai tout le loisir de modifier les commentaires des dizaines de fichiers et des centaines de méthodes, si vous vous voulez le faire ya pas de soucis :=)


Cause Im as free as a bird now, And this bird you can not change. - Freebird - Lynyrd Skynyrd
There's someone in my head but it's not me. - Brain damage - Pink Floyd
I said baby, you know Im gonna leave you. - Babe I'm gonna leave you - Led Zeppelin
Father ? yes son, I want to kill you - The end - The Doors
 
Equipe de support
Avatar de Shekral
  • Age : 23 ans
  • Messages : 950
  • Inscrit : 25 Février 2006
Message édité 1 fois, dernière édition par Shekral, 06 Septembre 2007, 17:20     Lien vers ce message 06 Septembre 2007, 17:18
C'est vrai que ce serai des plus pratique…

Edit: C'est pas simple de commenter le code d'un autre... déjà que prendre la suite même avec des commentaires et bien fait c'est rarement simple.


WikiFSB
 
Volcan
Avatar de Talus
  • Age : 20 ans
  • Messages : 1552
  • Inscrit : 28 Septembre 2006
Message édité 1 fois, dernière édition par Talus, 06 Septembre 2007, 18:15     Lien vers ce message 06 Septembre 2007, 18:14
Ben disons que les commentaires des méthodes sont assez proches de phpdoc, y'a juste des trucs à adapter (donc rien à comprendre :=) )


 
Equipe des MODS
Avatar de Korko
  • Age : 22 ans
  • Messages : 2688
  • Inscrit : 06 Octobre 2004
  Lien vers ce message 06 Septembre 2007, 18:17
Va falloir aussi corriger les fautes d'orthographe du code aussi :p


Dieu vous aime. Offre soumise à conditions
Je suis une Brute
 
Chef du projet FSB
Avatar de Genova
  • Age : 22 ans
  • Messages : 14520
  • Inscrit : 16 Septembre 2004
  Lien vers ce message 06 Septembre 2007, 18:24
Je pense qu'il y a d'autres priorités ;)


Cause Im as free as a bird now, And this bird you can not change. - Freebird - Lynyrd Skynyrd
There's someone in my head but it's not me. - Brain damage - Pink Floyd
I said baby, you know Im gonna leave you. - Babe I'm gonna leave you - Led Zeppelin
Father ? yes son, I want to kill you - The end - The Doors
 
Equipe de support
Avatar de B.Moncef
  • Age : 18 ans
  • Messages : 1926
  • Inscrit : 10 Septembre 2005
Message édité 1 fois, dernière édition par B.Moncef, 06 Septembre 2007, 18:32     Lien vers ce message 06 Septembre 2007, 18:30
J'ai deja essaye de m'y coller mais bon seul c'etait mission impossible ...

EDIT : Sinon grummfy m'avait dit que doxygen prenait en compte les commentaires style C ou C++ me rappelle plus, donc si quelqu'un pouvait essayer.
 
Volcan
Avatar de Talus
  • Age : 20 ans
  • Messages : 1552
  • Inscrit : 28 Septembre 2006
  Lien vers ce message 06 Septembre 2007, 18:34
Bah, on verra bien à la RC5 (genre se partager le boulot :p).

Sinon, pour doxygen, pas essayé.. (et flemme de le faire surtout). Que ce soit soit des commentaires C/C++, ou bien autres, ce sera le même travail je pense...


 
Equipe de support
Avatar de B.Moncef
  • Age : 18 ans
  • Messages : 1926
  • Inscrit : 10 Septembre 2005
  Lien vers ce message 06 Septembre 2007, 18:38
non je veux dire essayer d'utiliser doxygen avec ce qui existe deja comme commentaires dans les sources.
 
Chef du projet FSB
Avatar de Genova
  • Age : 22 ans
  • Messages : 14520
  • Inscrit : 16 Septembre 2004
  Lien vers ce message 06 Septembre 2007, 18:51
J'avoue franchement que passer toute une journée à réécrire les commentaires pour les rendre compatible avec PHPDocumentor, pour sortir une documentation à l'intéret douteux ça me botte pas, mais alors pas du tout.
Surtout que PHPDocumentor ça ne fait que lister de façon un peu plus joli les classes. Sachant que les classes de FSB sont organisées de manières très compréhensible, il suffit simplement de regarder le dossier main/class/ pour trouver ce qu'on veut.


Cause Im as free as a bird now, And this bird you can not change. - Freebird - Lynyrd Skynyrd
There's someone in my head but it's not me. - Brain damage - Pink Floyd
I said baby, you know Im gonna leave you. - Babe I'm gonna leave you - Led Zeppelin
Father ? yes son, I want to kill you - The end - The Doors
 
Equipe des MODS
Avatar de Grummfy
  • Age : 23 ans
  • Messages : 5469
  • Inscrit : 16 Septembre 2004
  Lien vers ce message 06 Septembre 2007, 19:54
geno, on sais que tu n'y trouve pas d'intéret, je pense que la communauté s'arrangera pour le faire d'une manière ou d'une autre!


"La gravité est le bonheur des imbéciles" Charles de Montesquieu > "T'as raison, L'apesanteur c'est plus rigolo" Hébus de Phalompe (Troll de Troy)
http://www.grummfy.com/download/crea/smileys/fsb2.gif Mods fsb1 - Mods fsb2 - Mon forum - Grummfy's project
 
Chef du projet FSB
Avatar de Genova
  • Age : 22 ans
  • Messages : 14520
  • Inscrit : 16 Septembre 2004
  Lien vers ce message 06 Septembre 2007, 20:00
pourquoi ne pas se concentrer sur le wiki plutot ?


Cause Im as free as a bird now, And this bird you can not change. - Freebird - Lynyrd Skynyrd
There's someone in my head but it's not me. - Brain damage - Pink Floyd
I said baby, you know Im gonna leave you. - Babe I'm gonna leave you - Led Zeppelin
Father ? yes son, I want to kill you - The end - The Doors
 
Répondre


.