forum

Support Général » A quand une doc'

Booster Mortier

rank_4.png

Avatar

Inscrit le: 04/10/2010

Messages: 795

Le 12/11/2017 à 14h11
Bonjour,

Voulant faire des modules pour PHPBoost, il me semble que c'est pas vraiment possible suite au manque critique de documentation sur les différentes fonctions qu'offre PHPBoost, tel que les formulaires, et bien d'autres choses.

Y aura t-il une documentation ? C'est peut-être pour cela que personne ne fait de module, peut-être qu'il n'y a pas assez de documentation pour permettre la création de ceux-ci

Merci pour vos réponses :)
Site web    

Modérateur

rank_modo.png

Avatar

Equipe Rédaction

Inscrit le: 26/12/2015

Messages: 244

Le 12/11/2017 à 18h03
Bonjour,

Je suis tout à fait d'accord et nous y travaillons.
Vous pouvez en attendant trouver bcp de renseignements sur les formulaires dans le module sandbox.

Cordialement,
Xela.
   

Booster Mortier

rank_4.png

Avatar

Inscrit le: 04/10/2010

Messages: 795

Le 12/11/2017 à 21h11
Oui ça je veux bien le croire, mais justement dans ce module sandbox il n'y a aucune indication sur par exemple "Comment enregistrer les données" transmise par le formulaire dans une BDD et ainsi de suite :)
Site web    

Booster Fusée

rank_6.png

Avatar

Equipe Assistance

Inscrit le: 07/12/2007

Messages: 5719

Le 12/11/2017 à 21h21
Bonjour,

je conseil de prendre exemple sur les modules news et/ou articles pour voir le fonctionnement complet.

Cordialement, janus57


Ma boule de cristal est en panne. merci de donner les détails de votre problème
   

Booster Minigun

rank_1.png

Avatar

Inscrit le: 15/04/2013

Messages: 25

Le 13/11/2017 à 12h28
C'est pas forcement un bonne solution janus.
Ni pour la doc, ni pour le dev.

Se baser sur du code dépanne, mais ne donne pas toutes les infos.
Sur la V3 on pouvais remonter dans le core pour retrouver les déclaration des fonctions. Ce qui dorénavant est extrêmement trop long et fastidieux.

Pour écrire dans un bdd, il faut quelle soit déclaré dans 3 fichier différent il me semble. la structure, la mise en en place, et le fonctionnement.
Mais n'ayant pas toutes les subtilité, je me suis résigné a pas y touché justement.

Sans compté que le dev actuel de pbt ne permet pas de faire des modules de façon perenne. on est pas a l'abris que dans la version +1 les fonctions soit modifier et non retro active, non commenter, documenter.....

L'evolution c'est bien, mais cela manque de sens et d'ordre. Des version stable et de référence serais un plus, et permettrais de faire du dev plus sereinement.
La mise ne place d'une doc serais aussi plus facile.

Mais c'est pas la première fois que on vois des sujet du genre.
   

Modérateur

rank_modo.png

Avatar

Equipe Graphique

Inscrit le: 16/05/2008

Messages: 2164

Le 13/11/2017 à 18h13
Et le problème n'est pas tant de générer la doc, netbean a un outil intégré basé sur apigen, sublime-text et atom ont un plug-in qui ouvre le fichier qui correspond à la fonction avec un ctrl+clic, etc...
Le problème n'est pas non plus de mettre cette doc à disposition.
Non, définitivement, le problème est le "tagage" en bonne et due forme des 600 fichiers du kernel pour une efficacité optimale de cette doc. Mais avec un seul développeur au four et au moulin...

De fait, pas de doc, pas de développeur en plus... pas de développeur en plus, pas de doc, Ouroboros est dans la place :)



Site web    

Booster Mortier

rank_4.png

Avatar

Inscrit le: 31/05/2013

Messages: 609

Le 13/11/2017 à 19h52
Bonsoir,

Et si Vous arrêtiez temporairement le dev pour aider JS, à mettre la doc à jour ? Non ??
On ne va pas "mourir" d'attendre 6 mois , un an pour une 5.2 ..
Au bout d'un moment, il faut savoir poser ses outils pour optimiser tout cela non...

Je pense que cela serait un super plus pour PBt. A moins de continuer à la jouer perso ..
Parce qu'au final , il n'y a que vous pour faire du dev sans la Doc.

Bonne soirée ;)
Swan.



Edité par Swan Le 13/11/2017 à 19h53
Site web    

Administrateur

rank_admin.png

Avatar

Equipe Graphique

Inscrit le: 14/08/2009

Messages: 4589

Le 13/11/2017 à 20h50
Bonsoir,

Lorsque l'on ajoute des fonctions, nous ajoutons en même temps les commentaires (dans la mesure du possible), mais il y a tout le passif à faire.

Que ce soit la v3, v4, v5, tous les éditeurs standard (notepad++ / sublimtext / eclipse / netbeans / phpstorm / etc...) savent remonter les fonctions simplement.

Pour le MVC/POO c'est un éternel débat entre structurer un projet de façon cohérente et appréhension pour les nouveaux. Mais il existe énormément de tuto sur internet qui permettent de comprendre le pourquoi c'est bénéfique.

Je note la proposition de retarder la 5.2 pour finaliser une API.

ElenWii
Site web    

Booster Minigun

rank_1.png

Avatar

Inscrit le: 15/04/2013

Messages: 25

Le 14/11/2017 à 11h09
Pourquoi faire une doc quand un soft peu le faire....

si je dis A + B = C c'est simple beau et fonctionnel.

Maintenant si je te dis que de la pâte et un pomme tu peux faire une tarte aux pommes c'est pareil, mais meilleur.


La documentation, oui, mais si elle est correctement compréhensible c'est mieux.
   

Administrateur

rank_admin.png

Avatar

Equipe Graphique

Inscrit le: 14/08/2009

Messages: 4589

Le 14/11/2017 à 20h26
J'ai pas dit que l'API était inutile parce que les outils pouvait remonter les fonctions ;)


Nous avons prévu de faire une doc du style apigen ou phpdocumentor. Et elle sera dans la langue commune des développeurs (en anglais).
Sur la partie "correctement compréhensible", est-ce que tu peux étoffer histoire de ne pas s'égarer en chemin ?
Site web    

Booster Mortier

rank_4.png

Avatar

Inscrit le: 31/05/2013

Messages: 609

Le 15/11/2017 à 13h58
Haa en tapant

"PHPBoost" ce matin dans google ...

Je suis tombé sur l'article du dessous. Et il dit de la doc :

Citation :
La documentation

Coté utilisation, rien à redire. La doc semble complète, mise à jour, avec des screens à foison. On sent vraiment que l’équipe met le paquet pour rendre le CMS accessible à n’importe qui.

En revanche, coté développement : Il y a du manque. On retrouve les bases pour créer un module, la hiérarchie à respecter, exécuter des requêtes SQL etc. Mais pour tout ce qui est API, bosser avec le noyau : Pas grand chose.
Il suffirait pourtant de générer une doc avec Apigen ou PHPDoc, mais non. Et puis faut avouer que dans les sources, il y a pas mal de fonctions sans commentaire.

L’équipe semble porter la priorité sur les nouvelles versions (ce que je comprends), mais elle en oublie les fondamentaux pour voir arriver de nouvelles recrues qui pourraient leur filer un coup de pouce.


C'est exactement ce que je vous disais, et que veut dire Sat sur la dernière phrase de l'article.

Ne vous en faite pas, j'en prends autant pour mon grade pour les thèmes .. :)

Swan.


Site web    

Modérateur

rank_modo.png

Avatar

Equipe Rédaction

Inscrit le: 26/12/2015

Messages: 244

Le 15/11/2017 à 15h25
Bonjour,

remettons les choses dans le bon ordre.
La doc n'est pas un centre de formation pour jeune dev.
Il y a des manques et tout le monde est d'accord.
Cependant, quand on se lance dans la création d'un module, il faut avoir un minimum de connaissances en php procédural, POO et MVC.
Dire que l'on arrive pas à trouver une méthode dans le noyau est absurde, quand on sait de quoi on parle. Et je dis bien "méthode" et non "fonction", ce qui est différent.
Il y a beaucoup de sites qui proposent des explications et des tutos sur la POO et MVC. Commencez par ça! Ensuite découvrir comment le noyau de Phpbboost fonctionne vous semblera plus évident. Du coup, trouver une méthode, vous prendra que peu de temps (encore moins avec les outils que l'équipe va mettre à votre disposition).
Exemple extravagant : se lancer dans la création de thème sans connaitre HTML5 ou CSS3 (ou encore JQUERY et j'en passe) est d'une grande maladresse. Et bien c'est pareil pour le dev en Php.
Pourquoi je dis tout ça : remettre en cause la programmation en MVC et POO, c'est être à l'opposé des avancées technologiques en termes d’efficacité, de modularité et de rapidité. Parler de V3 en référence prouve qu'il y a un manque de connaissances considérables.
Donc proposer des améliorations de la doc c'est bien mais tirer sur l'ambulance en permanence et sans savoir de quoi on parle ça l'est moins.
En tant que bénévoles, on est pas là pour se faire taper sur les doigts, bien au contraire...

Cordialement,
Xela.



Edité par xela Le 15/11/2017 à 15h27
   

Booster Mortier

rank_4.png

Avatar

Inscrit le: 31/05/2013

Messages: 609

Le 15/11/2017 à 15h30
Re,

:x Heuu je ne voit pas ou je parle de la V3 ou de la programmation, mais d'un manque dans la doc dev.. Ne me fait pas dire ce que je n'ai pas dit ^^

Et au passage, moi aussi je suis bénévole, et je donne autant que les autres ;)

Swan.



Edité par Swan Le 15/11/2017 à 15h32
Site web    

Modérateur

rank_modo.png

Avatar

Equipe Rédaction

Inscrit le: 26/12/2015

Messages: 244

Le 15/11/2017 à 15h32
Citation :
Sur la V3 on pouvais remonter dans le core pour retrouver les déclaration des fonctions. Ce qui dorénavant est extrêmement trop long et fastidieux.


cf citation de Saturnin mais ce post est général.

Cordialement,
Xela.
   

Booster Minigun

rank_1.png

Avatar

Inscrit le: 15/04/2013

Messages: 25

Le 15/11/2017 à 15h33
voilà,

ElenWii tu voulait savoir ce qui ne vas pas dans la doc ? regarde la réponse ou réaction de xela.

en prime il est rédacteur, ce qui laisse rêveur tant a sa réaction.
L'article date de la V4 - v5 un des plus gros chantier.

Si la réponse des rédacteurs au problème de doc est : "allez vous former au php" c'est sur que c'est loin d’être gagné.

Bon courage ...
   
Répondre
Sujet verrouillé, vous ne pouvez pas poster de message
1 Utilisateur en ligne : 0 Administrateur, 0 Modérateur, 0 Membre et 1 Visiteur
Utilisateur en ligne : Aucun membre connecté