Bonjour, y a-t-il un moyen de mettre des variables dans de la doc en pod ?
Vous pouvez toujours les mettre directement $Comme::ca, ou en soulignant que c'est du code comme C<$Comme::ca>. Ou en les plaçant dans un paragraphe verbatim :
$Comme::ca
Mais en écrivant cela, j'ai l'impression de ne pas vraiment répondre à votre attente. Si vous nous expliquiez un tout petit mieux votre besoin, peut-être pourrions-nous mieux vous renseigner.
-- Paul Gaborit - <http://perso.enstimac.fr/~gaborit/> Perl en français - <http://perl.enstimac.fr/>
Bonjour,
y a-t-il un moyen de mettre des variables dans de la doc en pod ?
Vous pouvez toujours les mettre directement $Comme::ca, ou en
soulignant que c'est du code comme C<$Comme::ca>. Ou en les plaçant
dans un paragraphe verbatim :
$Comme::ca
Mais en écrivant cela, j'ai l'impression de ne pas vraiment répondre à
votre attente. Si vous nous expliquiez un tout petit mieux votre
besoin, peut-être pourrions-nous mieux vous renseigner.
--
Paul Gaborit - <http://perso.enstimac.fr/~gaborit/>
Perl en français - <http://perl.enstimac.fr/>
Bonjour, y a-t-il un moyen de mettre des variables dans de la doc en pod ?
Vous pouvez toujours les mettre directement $Comme::ca, ou en soulignant que c'est du code comme C<$Comme::ca>. Ou en les plaçant dans un paragraphe verbatim :
$Comme::ca
Mais en écrivant cela, j'ai l'impression de ne pas vraiment répondre à votre attente. Si vous nous expliquiez un tout petit mieux votre besoin, peut-être pourrions-nous mieux vous renseigner.
-- Paul Gaborit - <http://perso.enstimac.fr/~gaborit/> Perl en français - <http://perl.enstimac.fr/>
Moretti
Bonjour, y a-t-il un moyen de mettre des variables dans de la doc en pod ?
Merci
En fait, je voudrais que lorsque je mets des variables dans de la doc en pod, elles soient interpretees. $truc affiche $truc et pas la valeur de $truc $truc affiche $truc ...
-- Sebastien Moretti
Bonjour,
y a-t-il un moyen de mettre des variables dans de la doc en pod ?
Merci
En fait, je voudrais que lorsque je mets des variables dans de la doc en
pod, elles soient interpretees.
$truc affiche $truc et pas la valeur de $truc
$truc affiche $truc ...
Bonjour, y a-t-il un moyen de mettre des variables dans de la doc en pod ?
Merci
En fait, je voudrais que lorsque je mets des variables dans de la doc en pod, elles soient interpretees. $truc affiche $truc et pas la valeur de $truc $truc affiche $truc ...
En fait, je voudrais que lorsque je mets des variables dans de la doc en pod, elles soient interpretees. $truc affiche $truc et pas la valeur de $truc $truc affiche $truc ...
Le POD n'est pas utilisé lorsqu'on exécute le code d'un script ou d'un module. Il est considéré comme les commentaires (et donc ignoré).
À l'inverse, lorsqu'on interprète le POD (via un convertisseur pod2xxxx), le code est totalement ignoré (*) et donc les variables n'ont pas de valeurs (elles n'existent même pas).
En fait, pourriez-vous nous montrer un exemple réel de situation où vous auriez besoin de la valeur d'une variable en POD ?
(*) sauf astuces particulières (très rarement utilisées) et qui, au mieux, permettent juste qu'une partie du code soit considéré comme du texte faisant partie de la documentation.
-- Paul Gaborit - <http://perso.enstimac.fr/~gaborit/> Perl en français - <http://perl.enstimac.fr/>
En fait, je voudrais que lorsque je mets des variables dans de la doc en
pod, elles soient interpretees.
$truc affiche $truc et pas la valeur de $truc
$truc affiche $truc ...
Le POD n'est pas utilisé lorsqu'on exécute le code d'un script ou d'un
module. Il est considéré comme les commentaires (et donc ignoré).
À l'inverse, lorsqu'on interprète le POD (via un convertisseur
pod2xxxx), le code est totalement ignoré (*) et donc les variables
n'ont pas de valeurs (elles n'existent même pas).
En fait, pourriez-vous nous montrer un exemple réel de situation où
vous auriez besoin de la valeur d'une variable en POD ?
(*) sauf astuces particulières (très rarement utilisées) et qui, au
mieux, permettent juste qu'une partie du code soit considéré comme du
texte faisant partie de la documentation.
--
Paul Gaborit - <http://perso.enstimac.fr/~gaborit/>
Perl en français - <http://perl.enstimac.fr/>
En fait, je voudrais que lorsque je mets des variables dans de la doc en pod, elles soient interpretees. $truc affiche $truc et pas la valeur de $truc $truc affiche $truc ...
Le POD n'est pas utilisé lorsqu'on exécute le code d'un script ou d'un module. Il est considéré comme les commentaires (et donc ignoré).
À l'inverse, lorsqu'on interprète le POD (via un convertisseur pod2xxxx), le code est totalement ignoré (*) et donc les variables n'ont pas de valeurs (elles n'existent même pas).
En fait, pourriez-vous nous montrer un exemple réel de situation où vous auriez besoin de la valeur d'une variable en POD ?
(*) sauf astuces particulières (très rarement utilisées) et qui, au mieux, permettent juste qu'une partie du code soit considéré comme du texte faisant partie de la documentation.
-- Paul Gaborit - <http://perso.enstimac.fr/~gaborit/> Perl en français - <http://perl.enstimac.fr/>
En fait, je voudrais que lorsque je mets des variables dans de la doc en pod, elles soient interpretees. $truc affiche $truc et pas la valeur de $truc $truc affiche $truc ...
Le POD n'est pas utilisé lorsqu'on exécute le code d'un script ou d'un module. Il est considéré comme les commentaires (et donc ignoré).
À l'inverse, lorsqu'on interprète le POD (via un convertisseur pod2xxxx), le code est totalement ignoré (*) et donc les variables n'ont pas de valeurs (elles n'existent même pas).
En fait, pourriez-vous nous montrer un exemple réel de situation où vous auriez besoin de la valeur d'une variable en POD ?
(*) sauf astuces particulières (très rarement utilisées) et qui, au mieux, permettent juste qu'une partie du code soit considéré comme du texte faisant partie de la documentation.
Disons que j'ai une variable $version valant 2.0.12 dans mon code. Elle est notamment utilisee lorsque que je fais 'mon_programme.pl --version". On retrouve la valeur 2.0.12 dans la doc en pod.
Je souhaiterais que le pod contienne $version pour que les modifications du numero de version se repercute dans le code et dans la doc en meme temps.
En fait, je voudrais que lorsque je mets des variables dans de la doc en
pod, elles soient interpretees.
$truc affiche $truc et pas la valeur de $truc
$truc affiche $truc ...
Le POD n'est pas utilisé lorsqu'on exécute le code d'un script ou d'un
module. Il est considéré comme les commentaires (et donc ignoré).
À l'inverse, lorsqu'on interprète le POD (via un convertisseur
pod2xxxx), le code est totalement ignoré (*) et donc les variables
n'ont pas de valeurs (elles n'existent même pas).
En fait, pourriez-vous nous montrer un exemple réel de situation où
vous auriez besoin de la valeur d'une variable en POD ?
(*) sauf astuces particulières (très rarement utilisées) et qui, au
mieux, permettent juste qu'une partie du code soit considéré comme du
texte faisant partie de la documentation.
Disons que j'ai une variable $version valant 2.0.12 dans mon code.
Elle est notamment utilisee lorsque que je fais 'mon_programme.pl
--version".
On retrouve la valeur 2.0.12 dans la doc en pod.
Je souhaiterais que le pod contienne $version pour que les modifications du
numero de version se repercute dans le code et dans la doc en meme temps.
En fait, je voudrais que lorsque je mets des variables dans de la doc en pod, elles soient interpretees. $truc affiche $truc et pas la valeur de $truc $truc affiche $truc ...
Le POD n'est pas utilisé lorsqu'on exécute le code d'un script ou d'un module. Il est considéré comme les commentaires (et donc ignoré).
À l'inverse, lorsqu'on interprète le POD (via un convertisseur pod2xxxx), le code est totalement ignoré (*) et donc les variables n'ont pas de valeurs (elles n'existent même pas).
En fait, pourriez-vous nous montrer un exemple réel de situation où vous auriez besoin de la valeur d'une variable en POD ?
(*) sauf astuces particulières (très rarement utilisées) et qui, au mieux, permettent juste qu'une partie du code soit considéré comme du texte faisant partie de la documentation.
Disons que j'ai une variable $version valant 2.0.12 dans mon code. Elle est notamment utilisee lorsque que je fais 'mon_programme.pl --version". On retrouve la valeur 2.0.12 dans la doc en pod.
Je souhaiterais que le pod contienne $version pour que les modifications du numero de version se repercute dans le code et dans la doc en meme temps.
Disons que j'ai une variable $version valant 2.0.12 dans mon code. Elle est notamment utilisee lorsque que je fais 'mon_programme.pl --version". On retrouve la valeur 2.0.12 dans la doc en pod.
Je souhaiterais que le pod contienne $version pour que les modifications du numero de version se repercute dans le code et dans la doc en meme temps.
Je me doutais que c'était un truc du genre...
En général, la "bonne" solution consiste justement à *ne* *pas* automatiser cela. Soit cette version (2.0.12) ne change rien au fonctionnement du module et dans ce cas il est inutile de le préciser dans la doc. Soit cette version (2.0.12) modifie le fonctionnement pour l'utilisateur et alors, il ne suffit pas de changer le numéro de version, il faut aussi modifier le reste de la documentation pour expliquer ces changements. C'est uniquement quand ces changements auront été faits que vous pourrez dire que la documentation correspond à la version 2.0.12.
Comme exemple, regardez les doc de Perl ou des modules. En général, elles n'indiquent pas de numéro de version. En revanche, certaine paragraphes indiquent « avant la version n... » ou « depuis la version n... », etc. C'est bien plus important que d'indiquer simplement la version puisque cela permet au programmeur de comprendre pourquoi telle ou telle fonctionnalité ne marche plus comme avant...
-- Paul Gaborit - <http://perso.enstimac.fr/~gaborit/> Perl en français - <http://perl.enstimac.fr/>
Disons que j'ai une variable $version valant 2.0.12 dans mon code.
Elle est notamment utilisee lorsque que je fais 'mon_programme.pl
--version".
On retrouve la valeur 2.0.12 dans la doc en pod.
Je souhaiterais que le pod contienne $version pour que les modifications du
numero de version se repercute dans le code et dans la doc en meme temps.
Je me doutais que c'était un truc du genre...
En général, la "bonne" solution consiste justement à *ne* *pas*
automatiser cela. Soit cette version (2.0.12) ne change rien au
fonctionnement du module et dans ce cas il est inutile de le préciser
dans la doc. Soit cette version (2.0.12) modifie le fonctionnement
pour l'utilisateur et alors, il ne suffit pas de changer le numéro de
version, il faut aussi modifier le reste de la documentation pour
expliquer ces changements. C'est uniquement quand ces changements
auront été faits que vous pourrez dire que la documentation correspond
à la version 2.0.12.
Comme exemple, regardez les doc de Perl ou des modules. En général,
elles n'indiquent pas de numéro de version. En revanche, certaine
paragraphes indiquent « avant la version n... » ou « depuis la version
n... », etc. C'est bien plus important que d'indiquer simplement la
version puisque cela permet au programmeur de comprendre pourquoi
telle ou telle fonctionnalité ne marche plus comme avant...
--
Paul Gaborit - <http://perso.enstimac.fr/~gaborit/>
Perl en français - <http://perl.enstimac.fr/>
Disons que j'ai une variable $version valant 2.0.12 dans mon code. Elle est notamment utilisee lorsque que je fais 'mon_programme.pl --version". On retrouve la valeur 2.0.12 dans la doc en pod.
Je souhaiterais que le pod contienne $version pour que les modifications du numero de version se repercute dans le code et dans la doc en meme temps.
Je me doutais que c'était un truc du genre...
En général, la "bonne" solution consiste justement à *ne* *pas* automatiser cela. Soit cette version (2.0.12) ne change rien au fonctionnement du module et dans ce cas il est inutile de le préciser dans la doc. Soit cette version (2.0.12) modifie le fonctionnement pour l'utilisateur et alors, il ne suffit pas de changer le numéro de version, il faut aussi modifier le reste de la documentation pour expliquer ces changements. C'est uniquement quand ces changements auront été faits que vous pourrez dire que la documentation correspond à la version 2.0.12.
Comme exemple, regardez les doc de Perl ou des modules. En général, elles n'indiquent pas de numéro de version. En revanche, certaine paragraphes indiquent « avant la version n... » ou « depuis la version n... », etc. C'est bien plus important que d'indiquer simplement la version puisque cela permet au programmeur de comprendre pourquoi telle ou telle fonctionnalité ne marche plus comme avant...
-- Paul Gaborit - <http://perso.enstimac.fr/~gaborit/> Perl en français - <http://perl.enstimac.fr/>
