Nouveau sujet Répondre Imprimer Syndication RSS 2.0

Suggestion Chiante

Documentation du code...
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

Reprise du dernier message

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
 
Equipe des MODS
Avatar de Grummfy
  • Age : 23 ans
  • Messages : 5469
  • Inscrit : 16 Septembre 2004
  Lien vers ce message 06 Septembre 2007, 20:03
ben on s'y concentre...
mais ce n'est pas le même but ...


"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
 
Volcan
Avatar de Talus
  • Age : 20 ans
  • Messages : 1552
  • Inscrit : 28 Septembre 2006
  Lien vers ce message 06 Septembre 2007, 20:05
Ben le wiki, c'est plus en détails (trop de détails), alors que ca, ca permet de générer une "vraie" documentation, dans le sens ou on a accès aux classes, un exemple (si y'a besoin), et un rapide descriptif (en gros, dans le genre Doc PHP). A moins que n'ailles à chaque fois consulter une tutorial PHP concernant (par exemple) la fonction sprintf() à chaque fois que tu as besoin de jeter un oeil sur les arguments, au lieu de jeter un oeil sur la doc PHP, pour voir un rapide descriptif et la liste des arguments (et eventuellement un petit exemple)...


 
Chef du projet FSB
Avatar de Genova
  • Age : 22 ans
  • Messages : 14520
  • Inscrit : 16 Septembre 2004
  Lien vers ce message 06 Septembre 2007, 20:06
Ben si, puisque le Wiki sera fait à la fois pour les utilisateurs de base, et aussi pour les moddeurs. L'API de FSB2 sera expliquée dans le Wiki, ainsi que les principales classes. Ce sera donc une sorte de PHPDocumentator en mieux et plus efficace.


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
Message édité 1 fois, dernière édition par Talus, 06 Septembre 2007, 20:13     Lien vers ce message 06 Septembre 2007, 20:13
Ben, honnetement, je trouve que le wiki n'est pas vraiment fait pour ca... Il donne juste les trucs qu'il faut pour savoir utiliser telle ou telle fonctionnalité, mais il donne pas vraiment une documentation précise des fonctions et des classes de FSB2... Ce pourrait genre être un ajout d'un lien dans le wiki, pour un truc plus avancé (et puis en même temps, si d'autres veulent perdre leur temps à ca.. :p)


 
Chef du projet FSB
Avatar de Genova
  • Age : 22 ans
  • Messages : 14520
  • Inscrit : 16 Septembre 2004
Message édité 1 fois, dernière édition par Genova, 06 Septembre 2007, 20:21     Lien vers ce message 06 Septembre 2007, 20:16
Bon ben do as you wish pour la documentation si vous l'estimez utile dans ce cas ;)

EDIT : vous dites que phpBB3 utilise PHPDocumentator, mais on peut pas dire qu'ils se sont emmerdés, ils n'ont renseignés casiment aucun argument pour la plupart des fonctions.


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
Message édité 1 fois, dernière édition par Talus, 06 Septembre 2007, 20:22     Lien vers ce message 06 Septembre 2007, 20:21
Ui, mais ils ont quand même renseigné la structure :p

(Me semblait que c'etait renseigné auparavant)

Bref, raison de plus pour faire mieux 8)


 
Equipe de support
Avatar de B.Moncef
  • Age : 18 ans
  • Messages : 1926
  • Inscrit : 10 Septembre 2005
  Lien vers ce message 06 Septembre 2007, 20:37
Pour moi si on compare FSB a PHP par exemple, le wiki c'est les tutos de developpez, du site du zero etc., et la doc c'est php.net

C'est pas un tres bon exemple mais c'est a peu pres ca. Mais bon on s'arrangera a la sortie de FSB finale
 
Volcan
Avatar de Talus
  • Age : 20 ans
  • Messages : 1552
  • Inscrit : 28 Septembre 2006
  Lien vers ce message 06 Septembre 2007, 20:44
Pour moi si on compare FSB a PHP par exemple, le wiki c'est les tutos de developpez, du site du zero etc., et la doc c'est php.net

C'est pas un tres bon exemple mais c'est a peu pres ca. Mais bon on s'arrangera a la sortie de FSB finale


C'est ce que je disais plus haut... ^^


 
Equipe de support
Avatar de Shekral
  • Age : 23 ans
  • Messages : 950
  • Inscrit : 25 Février 2006
  Lien vers ce message 06 Septembre 2007, 23:04
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.

Euh... Tu codes pas en Java toi ? L'utilisation de la Javadoc m'a vraiment convaincu de l'utilité de ce genre de documentation que ce soit pour Java ou pour une librairie. C'est pratique, on trouve plus rapidement que dans un Wiki (c'est pas son but au wiki), et on voit plus facilement la structure, les liens qui peut y avoir entre différentes fonctions.


WikiFSB
 
Etoile
Avatar de BlackJowy
  • Age : 22 ans
  • Messages : 3477
  • Inscrit : 01 Mars 2007
  Lien vers ce message 06 Septembre 2007, 23:47
Perso j'ai jamais besoin eu de ça pour comprendre le code de FSB2, ça fait à peine plus de 6 mois que je joue avec FSB2, et je pense pouvoir me considérer comme faisant partie des 10 personnes qui connaissent le mieux son code...

Je veux bien croire que ça serait utile à certains, mais comme l'a dit Genova, libre à vous de mener à bien ce projet si il vous tient à coeur... Je vois pas l'intérêt d'épiloguer la dessus en fait, vous voulez un phpDocumentator, ben à la sortie de la RC5 travaillez à cela :D


"It's backup day today so I'm pissed off. Being the BOFH, however, does have it's advantages. I reassign null to be the tape device — it's so much more economical on my time as I don't have to keep getting up to change tapes every 5 minutes. And it speeds up backups too, so it can't be all bad can it? Of course not." S.Travaglia

 
Flammeche
Avatar de nosmile
  • Age : 22 ans
  • Messages : 80
  • Inscrit : 22 Aout 2007
  Lien vers ce message 06 Septembre 2007, 23:48
Ben, c'est vrai que la javadoc est super utile, mais il y a une différence il me semble :

Quand tu écris un programme en java, tu pars de zero. Par contre, quand tu écris un mod, tu modifie un programme et, par conséquent, le but n'est pas de connaître les fonction qui existe mais de les modifier et, donc, de comprendre comment elle marche. Et ça, la meilleure solution, c'est de lire le code...

PHPDocumentor n'est pas (peu?) utile dans le cadre de la création de mod parce que, quoiqu'il arrive, tu devras te plonger dans le code et comprendre son fonctionnement avant de pouvoir commencer à coder ta modification. Si les module s'écrivait comme un plug'in firefox ou autre, alors effectivement se serait intéressant. Mais la, le but n'est pas d'utiliser des fonunections déjà écrite, c'est de les modifier.

Par contre, là ou PHPDocumentor serait utile, c'est pour lister les fonctions commune à toutes les classes et souvent utilisée (utilisation de la db, etc.)... Mais en tout cas, pas pour tout les objets et, donc, pas grand chose finalement. (Surtout que c'est des fonction qu'on voit partout dans le code...)

Bref, je suis de l'avis de Genova : le wiki me semble amplement suffisant à cette tâche et PHPDocumentor, trop fastidieux à "implementer" pour ce qu'il apporterait.

Maintenant, je n'ai jamais fait qu'un mod jusque maintenant, donc, je dis peut-être des conneries...


Ça sert à rien mais ça me fait bien marrer :
http://www.uptimeprj.com/img/nosmile/54bcc3f47a2b67426c54d7cddfc768fd.png
 
Equipe des MODS
Avatar de Grummfy
  • Age : 23 ans
  • Messages : 5469
  • Inscrit : 16 Septembre 2004
  Lien vers ce message 06 Septembre 2007, 23:49
tait toi ... ou ghuntur avec un H te parlera ...


"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
 
Etoile
Avatar de BlackJowy
  • Age : 22 ans
  • Messages : 3477
  • Inscrit : 01 Mars 2007
  Lien vers ce message 06 Septembre 2007, 23:52
@nosmile: Non tu ne dis pas de connerie :p Modder sur FSB2, c'est facile, ça demande un effort pour le premier mod, après ça passe tout seul.


"It's backup day today so I'm pissed off. Being the BOFH, however, does have it's advantages. I reassign null to be the tape device — it's so much more economical on my time as I don't have to keep getting up to change tapes every 5 minutes. And it speeds up backups too, so it can't be all bad can it? Of course not." S.Travaglia

 
Flammeche
Avatar de nosmile
  • Age : 22 ans
  • Messages : 80
  • Inscrit : 22 Aout 2007
  Lien vers ce message 06 Septembre 2007, 23:52
me disait aussi...


Ça sert à rien mais ça me fait bien marrer :
http://www.uptimeprj.com/img/nosmile/54bcc3f47a2b67426c54d7cddfc768fd.png
 
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, 07 Septembre 2007, 2:21     Lien vers ce message 07 Septembre 2007, 2:20
Perso j'ai jamais besoin eu de ça pour comprendre le code de FSB2, ça fait à peine plus de 6 mois que je joue avec FSB2, et je pense pouvoir me considérer comme faisant partie des 10 personnes qui connaissent le mieux son code...


Je viens d'apprendre le php sur le sdz et j'ai decide de faire un site base sur FSB. je veux pas perdre 6 mois a lire le code de FSB et j'ai pas la capacite de me plonger dans le code et le comprendre comme le font les bons codeurs comme BJ. J'ai donc juste besoin de savoir quels arguments passer a la fonction qui logue un utilisateur, et quel valeur de retour attendre de celle qui liste les forums.

La solution ? le wiki ? non. Ah oui, la doc bien sur ...

Ici on ne parle pas juste de mods, de codeurs confirmes ou de personnes qui savent s'y prendre, c'est surtout au debutant que ca sert. C'est sur que les personnes qui sont constamment sur ce forum, a modder, essayer d'aider, voir et revoir le code, pourront facilement comprendre sans doc, mais les autres non. Donc moi j'en ai pas besoin, toi non plus BJ, et toi non plus nosmile, mais lui si ;) . Faut penser a lui ;).
 
Répondre


.