Annonce

  •  » Outils
  •  » Documentation développeur ?

#1 2009-12-16 09:48:40

tosca
Former Piwigo Team
Cévennes (Gard)
2006-09-23
3818

Documentation développeur ?

Après mon cours intensif accéléré Smarty, je replonge dans le code Piwigo, histoire de peaufiner ma culture personnelle ...
Pour repérer les fonctions, variables, etc. y a-t-il une documentation développeur consultable par le commun des mortels ? ou faut-il explorer en détail les modules des différents répertoires ?

Hors ligne

#2 2009-12-16 11:28:21

Gotcha
Equipe Piwigo
Pierrelatte (26)
2007-03-14
13331

Re: Documentation développeur ?

La documentation développeur (plugin surtout) est une point à ne pas négliger afin d'attirer le plus de candidats possible et afin de leurs donner les meilleurs moyens de sortir des plugins efficaces.

Pour moi c'est très important pour le développement de Piwigo.


Ayez comme premier réflexe de consulter le wiki.
Ensuite, veuillez effectuer une recherche sur le forum avant de poser votre question.

LE FAIRE EST LE REVELATEUR DE L'ETRE

Hors ligne

#3 2009-12-16 20:27:12

grum
Former Piwigo Team
50% Nantes - 50% Paris
2007-09-10
2502

Re: Documentation développeur ?

Pour les évènements, il existe le plugin EventTracer qui les listes.
Mis à part çà, faut lire le source :)


Mes photos avec Piwigo évidemment !
[ www.grum.fr ] [ photos.grum.fr ]

Hors ligne

#4 2009-12-16 20:43:40

tosca
Former Piwigo Team
Cévennes (Gard)
2006-09-23
3818

Re: Documentation développeur ?

grum a écrit:

Pour les évènements, il existe le plugin EventTracer qui les listes.

Merci pour le tuyau.

grum a écrit:

Mis à part çà, faut lire le source :)

C'est ce que j'avais commencé à faire ... mais j'espérais néanmoins trouver une "cartographie" quelconque de fonctions, variables, etc qui m'aurait permis d'éviter de chercher 25 aiguilles en même temps dans 35 meules de foin différentes  ;)

Hors ligne

#5 2009-12-16 21:48:36

grum
Former Piwigo Team
50% Nantes - 50% Paris
2007-09-10
2502

Re: Documentation développeur ?

au début, je m'étais fait une espèce de cartographie des fonctions et données importantes.
pis j'ai laissé tombé : trop lourd à maintenir ^^;


Mes photos avec Piwigo évidemment !
[ www.grum.fr ] [ photos.grum.fr ]

Hors ligne

#6 2009-12-16 21:55:31

tosca
Former Piwigo Team
Cévennes (Gard)
2006-09-23
3818

Re: Documentation développeur ?

grum a écrit:

au début, je m'étais fait une espèce de cartographie des fonctions et données importantes.
pis j'ai laissé tombé : trop lourd à maintenir ^^;

D'autant plus que c'est justement au début qu'on en a besoin ! Après, on est en terrain connu ;)

Hors ligne

#7 2009-12-16 22:11:26

Gotcha
Equipe Piwigo
Pierrelatte (26)
2007-03-14
13331

Re: Documentation développeur ?

Je déplace le sujet dans une autre section du forum car elle concerne pour moi "l'outillage" pour Piwigo :-)


Ayez comme premier réflexe de consulter le wiki.
Ensuite, veuillez effectuer une recherche sur le forum avant de poser votre question.

LE FAIRE EST LE REVELATEUR DE L'ETRE

Hors ligne

#8 2009-12-16 22:20:42

tosca
Former Piwigo Team
Cévennes (Gard)
2006-09-23
3818

Re: Documentation développeur ?

Gotcha a écrit:

Je déplace le sujet dans une autre section du forum car elle concerne pour moi "l'outillage" pour Piwigo :-)

En fait, j'ai peut-être mal posé ma question ; mais là, j'avais bien la casquette de l'utilisateur/développeur qui cherchait de l'info ;)

Hors ligne

#9 2009-12-16 22:26:48

plg
Équipe Piwigo
Nantes, France, Europe
2002-04-05
12590

Re: Documentation développeur ?

Il n'y a pas très longtemps (moins de 1 an), laurent.duretz avait proposé la mise en place de PHPXref et ça me semble être déjà un bon outil pour comprendre l'organisation du code dans Piwigo (qui include qui)


Les historiens ont établi que Pierrick était le premier utilisateur connu de Piwigo.

Hors ligne

#10 2009-12-16 22:30:04

tosca
Former Piwigo Team
Cévennes (Gard)
2006-09-23
3818

Re: Documentation développeur ?

Veux-tu dire que cet outil est capable d'analyser du code existant, même s'il ne comporte pas de balises ou commentaires spécifiques ? (pas pris le temps de regarder avant de poster).

Hors ligne

#11 2009-12-17 00:16:34

plg
Équipe Piwigo
Nantes, France, Europe
2002-04-05
12590

Re: Documentation développeur ?

tosca a écrit:

Veux-tu dire que cet outil est capable d'analyser du code existant, même s'il ne comporte pas de balises ou commentaires spécifiques ? (pas pris le temps de regarder avant de poster).

oui, c'est le principe de ce logiciel. Maintenant de là à dire qu'il va te donner toutes les infos dont tu rêves, il y a un pas, que je ne vais pas franchir.


Les historiens ont établi que Pierrick était le premier utilisateur connu de Piwigo.

Hors ligne

#12 2009-12-17 00:21:43

tosca
Former Piwigo Team
Cévennes (Gard)
2006-09-23
3818

Re: Documentation développeur ?

plg a écrit:

oui, c'est le principe de ce logiciel. Maintenant de là à dire qu'il va te donner toutes les infos dont tu rêves, il y a un pas, que je ne vais pas franchir.

Je vais tâcher de ne pas me laisser emporter par mes fantasmes :D
Merci de la piste en tout cas.

Hors ligne

#13 2009-12-17 01:36:07

datajulien
Membre
Bruxelles (BE)
2009-07-29
282

Re: Documentation développeur ?

au même titre que doxygen (que j'utilisais régulièrement pdt mes études, et que je trouve très bien..., je vais tester phpxref pour voir), sans un minimum de tag et de description dans le source, seule la structure du code est récupérable.

Petit message subliminal aux devs, la mise en place de commentaire de base dans le source c'est bien! :)

[PS.] moi même je commente rarement...[/PS]

Hors ligne

#14 2009-12-17 07:45:53

tosca
Former Piwigo Team
Cévennes (Gard)
2006-09-23
3818

Re: Documentation développeur ?

datajulien a écrit:

[PS.] moi même je commente rarement...[/PS]

Thème de méditation : "C'est toujours dans le code des autres qu'on souhaite trouver des commentaires."

Hors ligne

#15 2009-12-17 19:22:43

tosca
Former Piwigo Team
Cévennes (Gard)
2006-09-23
3818

Re: Documentation développeur ?

Très impressionnant ! Une fois résolus deux micros-problèmes ( "comment fait-on au juste pour lancer un programme en Perl ?" ;) puis répertoire du fichier "output" inexistant), le résultat est produit en moins d'une minute.

Code:

Processing Piwigo...
Source.............: /home/marie-noelle/Downloads/phpxref-0.7/../Piwigo/piwigo-2.0.6
Target.............: /home/marie-noelle/Downloads/phpxref-0.7/output
Scanning Tree......: OK - 1063 files to process
Pass One...........: 0%..10%..20%..30%..40%..50%..60%..70%..80%..90%..100%
Generating Output..: 0%..10%..20%..30%..40%..50%..60%..70%..80%..90%..100%
Variable references: 0%..10%..20%..30%..40%..50%..60%..70%..80%..90%..100%
Function references: 0%..10%..20%..30%..40%..50%..60%..70%..80%..90%..100%
Class references...: 0%..30%..40%..50%..80%..90%..100%
Constant references: 0%..10%..20%..30%..40%..50%..60%..70%..80%..90%..100%
Table references...: 

Some values were referenced in require and include statements
for which no value could be found in the configuration file so cross-referencing
may be incomplete: 
Unknown constant names (ref count): S (2), SMARTY_CORE_DIR (53), _ (24), UPGRADES_PATH (2), PHPWG_ROOT_PATH (297), LOCALEDIT_PATH (4), SMARTY_DIR (2), PHPWG_PLUGINS_PATH (1)
Unknown variable names (ref count): $page (1), $config_file (1), $_compile_file (1), $file_to_include (4), $file_name (1), $user (1), $smarty (1), $root (1), $_plugin_file (1), $method (1), $theme (1), $this (3), $upgrade_file (1), $styles (1), $source_file (1), $my_path (1), $filename (3), $_smarty_compile_path (3), $func (1), $upgrade_id (2)

Summary statistics:
Files Scanned: 1063 containing 132043 lines
2847 variable names in 6417 definitions and 55324 references.
1233 function/method names in 1013 definitions and 13142 references.
158 constant names in 238 definitions and 2677 references.
52 class names in 53 definitions and 377 references.
0 table names in 0 references.

Provisoirement, j'ai fait l'impasse sur les tables car je n'ai pas installé de BD Piwigo en local, mais j'y reviendrai.
Il ne me reste plus qu'à explorer ...

(PJ : copie écran de consultation)

Dernière modification par tosca (2009-12-17 19:33:47)

Hors ligne

  •  » Outils
  •  » Documentation développeur ?

Pied de page des forums

Propulsé par FluxBB

github twitter newsletter Faire un don Piwigo.org © 2002-2023 · Contact