info
Google Groups no longer supports new Usenet posts or subscriptions. Historical content remains viewable.
Dismiss
Groups keyboard shortcuts have been updated
Dismiss
See shortcuts
creare la documentazione dei propri progetti
14 views
Skip to first unread message
armony
May 18, 2021, 4:04:48 AM5/18/21
to
Salve a tutti, sto muovendo i primi passi con php.
Una domanda:
per creare la documentazione dei propri progetti cosa usate?
phpdoc dicono che sia uno strumento valido.
Cosa mi consigliate?
Una domanda:
per creare la documentazione dei propri progetti cosa usate?
phpdoc dicono che sia uno strumento valido.
Cosa mi consigliate?
armony
May 23, 2021, 5:31:04 AM5/23/21
to
Il 18/05/21 10:04, armony ha scritto:
Niente?
Non è molto frequentato questo ng.
Non è molto frequentato questo ng.
fmigliori
May 23, 2021, 5:21:44 PM5/23/21
to
hai ragione.
PHPDOC va benissimo anche se non credo sia compatibile con php 8
armony
May 24, 2021, 1:01:55 PM5/24/21
to
Il 23/05/21 23:21, fmigliori ha scritto:
Allora spiegatemi questo.
https://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.uses.pkg.html
"The @uses tag automatically creates a virtual @usedby tag in the other
documentation that links to the documentation containing the @uses tag.
In other words, it is exactly like @see, except a return link is added
automatically."
Facciamo qualche prova?
$ cat src.php
<?php
class Simona {
/**
* @uses Macchina::guida()
*/
static function parte() {
Macchina:guida();
}
}
class Macchina {
static function guida() {
}
}
$ phpdoc -f src.php -t docs/
phpDocumentor v3.0.0
Parsing files... blablabla...
$ grep -iq 'macchina::guida' docs/classes/Simona.html || echo INESISTEMTE
$ grep -iq 'simona::parte' docs/classes/Macchina.html || echo INESISTEMTE
INESISTEMTE
Come vedete, alla fine c'è un problema.
Il file docs/classes/Macchina.html dovrebbe contenere qualcosa di simile
public static guida()
usedby
simona::parte
ma risulta inesistente.
Perchè?
PS
Per capirci meglio ecco un paio di schermate di quello che ha generato
phpdoc:
https://pasteboard.co/K2qMZS2.png (Simona)
https://pasteboard.co/K2qOH6f.png (Macchina)
PS
Però cercate di impegnarvi per rispondere, e possibilmente fate delle prove.
https://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.uses.pkg.html
"The @uses tag automatically creates a virtual @usedby tag in the other
documentation that links to the documentation containing the @uses tag.
In other words, it is exactly like @see, except a return link is added
automatically."
Facciamo qualche prova?
$ cat src.php
<?php
class Simona {
/**
* @uses Macchina::guida()
*/
static function parte() {
Macchina:guida();
}
}
class Macchina {
static function guida() {
}
}
$ phpdoc -f src.php -t docs/
phpDocumentor v3.0.0
Parsing files... blablabla...
$ grep -iq 'macchina::guida' docs/classes/Simona.html || echo INESISTEMTE
$ grep -iq 'simona::parte' docs/classes/Macchina.html || echo INESISTEMTE
INESISTEMTE
Come vedete, alla fine c'è un problema.
Il file docs/classes/Macchina.html dovrebbe contenere qualcosa di simile
public static guida()
usedby
simona::parte
ma risulta inesistente.
Perchè?
PS
Per capirci meglio ecco un paio di schermate di quello che ha generato
phpdoc:
https://pasteboard.co/K2qMZS2.png (Simona)
https://pasteboard.co/K2qOH6f.png (Macchina)
PS
Però cercate di impegnarvi per rispondere, e possibilmente fate delle prove.
0 new messages