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 .

Si je veux faire mon site sur base de FSB, j'utilise le mod My FSB Website

Si je veux jouer avec la session de l'utilisateur, je me plonge pas pendant un long moment dans la doc pour trouver ça, mais je lit le passionnant (et explicite) article trouvé sur le wiki http://www.fire-soft-board.com...ns:lier_au_site

Sans compter le futur très passionnant article sur le SDK FSB2



Oui oui :



Travaillez pour lui donc, personne n'est contre, on est juste certains à dire qu'on s'en fou un peu. Je suis sur que Genova n'aura rien contre rendre votre idée disponible, une fois concrétisée

Sans vouloir aller à l'encontre de l'avis général, je pense plutôt qu'une doc est primordiale. En règle générale, que ce soit pour un langage, une API, ou autre, les codeurs n'ont pas forcément l'envie ni le temps d'aller voir la façon dont l'application est codée, ils veulent savoir comment appeler la fonction, et comment la fonction se comporte. En effet, avec du temps et des compétences, en lisant un code source, on arrive à décoder. Mais avec une doc bien faite, c'est immédiat.
Après phpDoc ou une autre doc, ce sont des débats de comptoir, mais je peux assurer que lire une bonne doc fait gagner un temps fou. Avec une bonne doc, on apprend un langage ou on maîtrise une application en quelques heures, le dixième du temps que l'on passerait à demander aux habitués comment on pourrait implémenter ci ou ça, et quand on n'a pas que ça à faire, on remercie les développeurs…

Lol j'y ai pas reflechi :d


C'etait un exemple parmi tant d'autres.


Je sais pas exactement ce que sera le SDK, ni sa doc, donc je peux pas en dire plus.


On sait que y en a qui s'en foutent comme y en a qui aimerait bien une doc, mais si on continue le debat c'est juste pour que chacun apporte son point de vue concernant l'utilite ou pas d'une doc.

Huhu, bien dit.

Voici ce que je plussoie (huhu) :






Je plussoie surtout le fait que tout le monde n'a pas 6 mois pour lire tout le code et le comprendre -.-

Au moins, essayer de prendre les habitudes dès maintenant...

Bon, voici mon avis...

La doc c'est bien, mais après un ou deux petits fix de bug par-ci, par-là, elle n'est plus à jour (là je parle d'expérience professionnelle).
Donc pour moi, si le code est clair, lisible et que les paramètres des fonctions sont documentés par de bons commentaires dans le code, j'ai rien à demander de plus.

Une bonne documentation est très importante pour un framework, mais FSB2 est avant tout un produit final, même s'il est facilement modifiable afin de l'utiliser autrement.

Donc au final, Genova a fait un suffisamment bon travail pour qu'une documentation ne soit pas indispensable (même si elle apporterait quelque chose de plus). Et la plupart des problèmes de compréhension ne viennent pas du code de FSB2 mais de lacune des langages utilisés.

Ben techniquement, pour la doc, suffit de suivre le schéma et de lancer une fois PHPDoc, et il fait le reste (même en local). Et, de plus, lors de fixes de bugs, en général, c'est pas souvent une méthode / fonction qui est modifiée en profondeur (type de résultat attendu, paramètres)...

Exact c'est surtout son fonctionnement interne qui est revu. Vu que la modification des paramètres ou de la valeur de retour de la fonction entraînerait des modifications autre part.


C'est bien ca le "problème", FSB peut être utilise comme un "framework" pour faire un site en entier basé dessus, ou juste un script de news basé dessus.


Qui a dit que le probleme etait dans le code de FSB 2 ? Le code est tres clair, structure, bien fait. Ca je suis d'accord.
Mais comme tu le dis, il y a certaines personnes qui ont quelques lacunes en PHP, et qui pourrait avoir grandement besoin de la doc.

En même temps quand j'y réflechis, même nous qui passons beaucoup de temps sur le forum et dans les fichiers de FSB, on pourrait avoir besoin de cette doc. Qui peut prétendre apprendre les prototypes de toutes les fonctions de FSB par coeur ? Personnellement si je ne me rappelle que du nom de la fonction, je préfère aller la chercher dans une doc, que dans des fichiers sources, mais ca reste un avis personnelle.

Bon pour clore le sujet : si vous estimez que ce genre de doc est indispensable, je vous laisse tout le loisir de le faire.

bon ben dès que la RC5 sort (ou la VF )

(Faudrait trouver une équipe pour =D)

ben tu peux t'en charger ...
suffit de créer un sujet, tu listes les fichiers (sous windows la comande tree, sous linux y a un équivalent mais m'en rappel plus)
et chacun prends un fichier ...

Ben pourquoi pas (genre faire un dossier chacun)

(Qui a dit que je voulais faire que le dossier "docs" ? )

apt-get install tree


Mais dans le genre impossible à retenir (et donc à faire sans un coup de man find) :

find . | sed 's/[^/]*\//| /g;s/| *\([^| ]\)/+--- \1/'

Ourf, pas mal la formule...

Mais dans le sens faire une équipe, au moins s'organiser (dans le sens ou ce serait con de faire le même truc à deux, sans asvoir que l'un et l'autre travaille dessus =D)

black > alias tree="find . | sed 's/[^/]*\//| /g;s/| *\([^| ]\)/+--- \1/'"

Talus > ben justement créer un nouveau sujet, ou carrément une page sur le wiki...

Pourquoi pas. J'attends alors la VF ou la RC5 =D