Alternativa alla documentazione POD di Perl in altre lingue?

3

Perl ha questo metodo di documentazione davvero interessante che semplifica la documentazione. Si chiama POD (Plain Old Documentation) . Ecco un esempio:

=head1 NAME

Example::Module - an example

=head1 SYNOPSIS

    use Example::Module;
    my $object = Example::Module->new();
    print $object->as_string;

=head1 DESCRIPTION

Just an example.

=head2 Methods

=over 12

=item C<new>

Returns a new My::Module object.

=item C<as_string>

Returns a stringified representation of
the object. This is mainly for debugging
purposes.

=back

=head1 LICENSE

This is released under the Artistic 
License. See L<perlartistic>.

=head1 AUTHOR

Dynamic 

=head1 SEE ALSO

L<perlpod>

=cut

L'output di questo sarebbe in HTML, come questo esempio su CPAN (non quello che ho scritto). Fantastico!

Quindi esiste un metodo simile al POD in cui uno sviluppatore può inserire la documentazione all'interno del codice stesso, senza che si tratti di un commento?

    
posta Dynamic 14.05.2012 - 21:12
fonte

1 risposta

4

JavaDocs sono molto simili a questo. Sono commenti ma sono una forma speciale di commento che viene poi compilata per produrre documenti che assomigliano alla documentazione ufficiale di Java.

Sia JavaDoc che POD sono esempi di "Generatori di documentazione" di cui ce ne sono molti. Wikipedia ha una lista di buone dimensioni per una varietà di piattaforme e lingue.

    
risposta data 14.05.2012 - 21:30
fonte

Leggi altre domande sui tag