Documentação Perl POD

Autor：Eve Cole Data da Última Atualização：2024-12-24 16:24:01

Em Perl, documentos POD (Plain Old Documentation) podem ser incorporados em módulos ou scripts.

POD é uma linguagem de marcação (linguagem de marcação) simples e fácil de usar.

Regras de uso de documentos POD:

O documento POD começa com =head1 e termina com =cut . Adicione uma linha em branco antes de =head1 e depois de =cut .

Perl ignora documentação em PODs. Os exemplos são os seguintes:

Exemplo

#!/usr/bin/perl imprimir " Olá, Mundo n " ; =head1 Olá, Mundo Exemplo Este é um exemplo simples de Perl. =cortar imprimir " Olá, Codercto n " ;

Executando o programa acima, o resultado de saída é:

 Olá, MundoOlá, Codercto

Também podemos usar "__END__" ou "__DATA__" para "comentar" todo o conteúdo após a linha:

Exemplo

#!/usr/bin/perl imprimir " Olá, Mundo n " ; while ( < DADOS > ) { imprimir $ _ ; __FIM__ =head1 Olá, Mundo Exemplo Este é um exemplo simples de Perl. print "Olá, Codercton";

Executando o programa acima, o resultado de saída é:

 Olá, Mundo=head1 Olá, Mundo Exemplo Este é um exemplo simples de Perl. print "Olá, Codercton";

O exemplo a seguir não lê o documento POD:

Exemplo

#!/usr/bin/perl imprimir " Olá, mundo n " ; END__ =head1 Olá, Mundo Exemplo Este é um exemplo simples de Perl. print "Olá, Codercton";

Executando o programa acima, o resultado de saída é:

 Olá, mundo

O que é POD?

Pod (Plain Old Documentation) é uma linguagem de marcação (linguagem de marcação) simples e fácil de usar, frequentemente usada para escrever documentos em programas e módulos Perl.

O conversor Pod pode converter Pod em vários formatos, como texto, HTML, man, etc.

A linguagem de marcação Pod contém três tipos básicos: normal, textual e de comando.

Parágrafos comuns : você pode usar códigos de formatação em parágrafos comuns, como negrito, itálico ou estilo de código, sublinhado, etc.

Parágrafo original : Parágrafo original, usado para blocos de código ou outras partes que não requerem processamento de conversor e não requerem reorganização de parágrafo.

Parágrafo de comando : Os parágrafos de comando atuam em todo o documento e geralmente são usados para configuração de título ou marcação de lista.

Todos os parágrafos de comando (que têm apenas uma linha) começam com "=", seguido por um identificador. O texto subsequente será afetado por este comando. Agora os comandos amplamente usados incluem

 =pod (documento inicial)=head1 title text=head2 title text=head3 title text=head4 title text=acima do número de espaços recuados=item prefix=back (end list)=formato inicial do documento=formato final do documento final=para formatar texto =codificação tipo de codificação=cortar (fim do documento)

Em perl, você pode usar pod2html **.pod >**.html para gerar documentos pod em formato html.

Considere a seguinte instância do POD:

Exemplo

=begin html=codificação utf-8 =head1 Tutorial do programador =cut

Quando pod2html for usado, este código será copiado do texto original.

Use o comando pod2html para executá-lo e convertê-lo em código HTML:

 $ pod2html teste.pod > teste.html

Abra test.html no navegador, a parte do link é o índice, conforme mostrado abaixo:

O exemplo a seguir escreve HTML diretamente no documento POD:

 =begin html=codificação utf-8<h1>Tutorial do codificador</h1><p> www.codercto.com </p>=end html

Quando pod2html for usado, este código será copiado do texto original.

Use o comando pod2html para executá-lo e convertê-lo em código HTML:

 $ pod2html teste.pod > teste.html

Abra test.html no navegador, a parte do link é o índice, conforme mostrado abaixo: