Pod :: modelo pod :: Modelo é um módulo Perl para a criação de documentação do POD a partir de modelos.
Baixe Agora

Pod :: modelo Classificação e resumo

Pod :: modelo Tag

Módulo Perl. construção Pod. documentação do pod. Documentação de modelos

Pod :: modelo Descrição

POD :: Modelo é um módulo Perl para construir documentação do POD de modelos. Pod :: Modelo é um módulo Perl para construir documentação do pod de modelos.synopsis ### como um módulo ### Use pod :: Modelo; Meu $ parser = New Pod :: Modelo; $ parser-> analisar (modelo => 'documentation.ptmpl'); imprimir $ parser-> as_string ### como um script ### $ podtmpl -i dir1 -i dir2 documentation.ptmpl ### um módulo simples preparado para usar pod :: modelo ### pacote meu :: módulo; = Modelo print_me = head2 print_me ($ string) imprime seu argumento. = Sub Print_me {Shift de impressão; Retornar 1} ### Um arquivo de pod simples chamado extra / adicional.pod ### = pod = model return_vals Esta sub-rotina retorna 1 para o sucesso e o Redef para falha. = corte ### um modelo simples :: modelo de modelo ### = include meu :: módulo = include extra / adicional.pod como extra = pod = head1 sinopse use meu :: módulo meu :: módulo :: print_me ('alguns texto'); = Head2 Functions = Inserir Meu :: Módulo-> Print_me = Inserir Extra-> Return_Vals = Documentação de cutwing em um projeto mantido por várias pessoas que abrangem mais de um módulo é uma questão complicada. Há muitas coisas a considerar: a vagem do local deve ser embutida (acima de todas as funções), na parte inferior do módulo, ou em um arquivo distinto? O primeiro é mais fácil para os desenvolvedores, mas os dois últimos são melhores para os mantenedores da POD.Orderwhat para que a documentação esteja em? Pertiga a ordem em que as funções são escritas ou ordenadas por outro princípio, como a frequência de uso ou tipo de função? Mais uma vez, a primeira opção é melhor para os desenvolvedores, enquanto os dois segundos são melhores para o usuário.Referenceshow caso uma função em outro arquivo seja mencionada? A documentação deve simplesmente dizer "ver outro :: módulo" ou incluir a seção relevante? Duplicação significa que a documentação é mais provável que seja desatualizada, mas é ruim para que um usuário tenha que ler numerosos documentos para simplesmente descobrir o que um método herdado faz.Headers e rodapés O que deve ser feito com cabeçalhos e rodapés padrão? Se eles sejam colados em todos os arquivos, ou o arquivo principal pode ser assumido para cobrir todo o projeto? O Modelo oferece uma solução para esses problemas: a documentação é construída a partir de modelos. Requisitos: · Perl.

Pod :: modelo Software Relacionado