Perl ha qualcosa come Java/PHP Docs?

Question

Perl ha un generatore Perl Docs? Qualcosa come Java Docs o PHP Documenter?

Answer 1

Sì, si chiama perldoc

è sufficiente scrivere la documentazione nella fonte, proprio come con javadoc.

In breve, "= articolo" è un elemento puntato, ad es. una funzione o un parametro "= over" scende di un livello di identificazione, "= back" sale di un livello. Usa "= cut" dove vuoi tornare al codice perl.

Ecco un esempio di ciò che potrebbe apparire come:

=item $b->add_module (%options) 

Initialize a module. A module is a repository or a branch of a repository. 
Valid options are 

=over 

=item id 

Id of this module 

=item repo 

Url of repository. Currently only subversion repositories are supported. 

=back 

=cut 
sub add_module($%) 
{ 

È sufficiente passare il codice Perl attraverso il programma perldoc per ottenere la documentazione formattata.

Answer 2

Intendi perldoc?

Vedi anche legati Stack Overflow quesion:

• What’s the best way to document Perl code?

Answer 3

Perché, sì. Sì, lo fa! Perldoc.

Answer 4

[solo per googlers] Come già detto, si crea documentazione con POD (non commenti, commenti per manutentori, pod per la documentazione utente). Di solito aggiungi il tuo POD all'inizio e alla fine del tuo script o modulo, e prima di ogni metodo), quindi puoi usare perldoc your_module nella console o pod2html per convertire in html e navigare in un server, oppure usare pdoc (è un un po 'vecchio ma è molto utile quando si desidera avere un navigatore di documenti Web e collegamenti al codice nel web).

c'è una questione più recente sulla formattazione del baccello che potrebbe essere anche di tuo interesse perl-documentation-pod-browsers

e questo how-can-i-generate-html-documentation-for-perl-code-comments

E ce n'era un altro a parlare per fare un pod2html e utilizzando un file css per imitare le pagine di ricerca, ma non riesco a trovarlo ora.