POD: Sjabloon POD :: Sjabloon is een PERL-module voor het bouwen van poddocumentatie van sjablonen.
Download nu

POD: Sjabloon Rangschikking & Samenvatting

POD: Sjabloon Tags

Perl-module gebouw PEUL pod documentatie templates documentatie

POD: Sjabloon Beschrijving

POD: Template is een PERL-module voor het bouwen van poddocumentatie van sjablonen. POD: Sjabloon is een PERL-module voor het bouwen van poddocumentatie van sjablonen.synopsis ### als module ### Gebruik pod :: sjabloon; Mijn $ PARDER = NIEUWE POD :: Sjabloon; $ Parser-> parsse (sjabloon => 'documentatie.ptmpl'); Print $ Parser-> AS_String ### als een script ### $ PODTMPL -I Dir1 -I Dir2 Documentation.PTMPL ### Een eenvoudige module voorbereid om POD te gebruiken :: Template ### Pakket Mijn ::: Module; = Sjabloon print_me = head2 print_me ($ string) drukt zijn argument af. = Sub print_me {print shift; Retourneer 1} ### een Simple POD-bestand met de naam Extra / Extra.Pod ### = POD = Sjabloon return_vals Dit subroutine retourneert 1 voor succes en undef voor falen. = Sneden ### een eenvoudige pod :: sjabloon sjabloon ### = COME :: Module = Extra / extra.pod als extra = pod = head1 synopsis Gebruik mijn :: module My ::: module :: print_me ('sommigen tekst'); = HOOFD2 FUNCTIES = INSERT MY :: MODULE-> PRINT_ME = BUITEN INSTELLEN EXTRA-> RETURN_VALS = CUSWRITING DOCUMENTATIE OP EEN PROJECT DIE DOOR VERSCHILLENDE MENSEN WELKE MENSEN DIE MEER DAN OVER EEN MODULE OVERSCHRIJDT. Er zijn veel dingen om te overwegen: LocationShould Pod Wees inline (boven elke functie), onderaan de module, of in een onderscheidend bestand? De eerste is gemakkelijker voor de ontwikkelaars, maar de laatste twee zijn beter voor de POD-onderhouder. Relderwelke bestel moet de documentatie binnen zijn? Behoort het in de volgorde waarin de functies worden geschreven, of besteld door een ander principe, zoals frequentie van gebruik of functietype? Nogmaals, de eerste optie is beter voor de ontwikkelaars, terwijl de tweede twee beter zijn voor de gebruiker .Referenceshow Moet een functie in een ander bestand worden vermeld? Mocht de documentatie gewoon zeggen 'Zie andere :: module', of moet het de relevante sectie bevatten? Duplicatie betekent dat de documentatie eerder verouderd is, maar het is slecht voor een gebruiker om talloze documenten te lezen om gewoon te ontdekken wat een geërfde methode doet. Hoofdslachten en voetenwat moet worden gedaan met standaardkoppen en voetteksten? Mochten ze worden geplakt in elk bestand, of kan het hoofdbestand worden verondersteld om het volledige project te dekken? POD :: Sjabloon biedt een oplossing voor deze problemen: documentatie is opgebouwd uit sjablonen. Vereisten: · Perl

POD: Sjabloon Gerelateerde software