Natuurlijke documenten

Natuurlijke DOCS - Open-Source, Extensible, Multi-Table Documentation Generator
Download nu

Natuurlijke documenten Rangschikking & Samenvatting

Advertentie

  • Rating:
  • Vergunning:
  • GPL
  • Prijs:
  • FREE
  • Naam uitgever:
  • Greg Valure
  • Uitgever website:
  • http://www.naturaldocs.org/about.html
  • Besturingssystemen:
  • Mac OS X
  • Bestandsgrootte:
  • 336 KB

Natuurlijke documenten Tags


Natuurlijke documenten Beschrijving

Natuurlijke Documenten - Open-Source, Extensible, Multi-Table Documentation Generator Natural Docs is een open-source, uitbreidbare, multi-language documentatie generator. Je hoeft alleen uw code te documenteren in een natuurlijke syntax dat net als gewoon Engels leest. Natural Docs scant uw code en een hoge kwaliteit HTML-documentatie van it.Here bouwen zijn een aantal belangrijke eigenschappen van "Natural Docs": Source Documentatie Natural, Leesbaar Syntax: · Natural Docs' syntax is ontworpen heel natuurlijk uit te zijn, bijna transparant. De opmerkingen in de broncode te lezen net zo gemakkelijk als de gegenereerde documentatie. Er is vrijwel geen labels bezaaid over. Meerdere talen: · Natural Docs ondersteunt negentien programmeertalen out of the box, zelfs binnen hetzelfde project. Het ondersteunt CGI en zonder extensie van bestanden, omdat het hun taal kan bepalen door hun keet lijnen. Voeg je eigen taal: · Als uw programmeertaal niet reeds is opgenomen in Natural Docs, kunt u ondersteuning voor het toevoegen alleen door het wijzigen van een configuratiebestand. Zelfs de meest obscure taal kan een krachtige documentatie generator hebben. All of gewoon Expliciete Documentatie: · Afhankelijk van uw niveau van taalondersteuning, kunt u kiezen tussen het hebben van Natural Docs document alles of alleen wat je gedocumenteerd, waardoor het geschikt is voor het genereren van API referenties maakt. Flexibele Sleutelwoorden: · Natural Docs heeft veel zoekwoorden voor elk van zijn onderwerp types, zodat u kunt gebruiken wat het meest natuurlijk voor je. U kunt ook de bestaande of voeg uw eigen. Custom onderwerpen en indexen: · Als u wil graag wat facet van je code te documenteren dat Natural Docs niet weet over - misschien is het iets bijzonder uw taal of project - u kunt uw eigen onderwerp type en zoekwoorden te maken voor het. Natural Docs zelfs bouwen een eigen index. Lijsten: · Natural Docs biedt een verkorte syntax voor het documenteren van grote groepen van kleine voorwerpen, zoals constanten. Ieder wordt een koppelbare symbool alsof het zijn eigen onderwerp. Vernieuwd OutputAttractive Documentatie: · In tegenstelling tot de meeste gegenereerde documentatie, output Natural Docs' ziet er professioneel standaard. Er zijn verschillende stijlen om uit te kiezen, of je kunt er zelf een te maken. Krachtige CSS Structuur: · Natural Docs heeft een krachtige, goed gedocumenteerd CSS structuur die volledige aanpassing mogelijk maakt. Hoewel de standaard stijlen niet altijd laat het zien, kun je dingen hebben zoals links naar functies één stijl en links naar klassen een ander te doen. U kunt zelfs browser-specifieke stijlen in een enkel CSS-bestand om te werken rond renderen eigenaardigheden. Transparante wijze onder handen genomen E-mailadressen: · E-mail adressen te zien zijn in de documentatie kijken en handelen als gewone e-mail verbindingen, maar ze zijn op transparante wijze onder handen genomen om te vermijden spam crawlers. Tooltips Overal: · Elke link naar elke gedocumenteerd onderwerp heeft zijn samenvatting als een tooltip. Links naar functies en variabelen hebben hun volledig opgemaakte prototypes in de tooltips ook. Al dan niet ingelijst HTML: · Het is uw documentatie, het is uw keuze. U kunt blijven elke pagina moet onafhankelijk zijn en gemakkelijk te koppelen, of u kunt het menu in een apart frame te houden voor eenvoudigere navigatie. Negeer Prefixen in de Index: · Common voorvoegsels hoeft niet naar uw indexen te ruïneren. Als al uw klassen beginnen met C, of als je een heleboel functies die beginnen met COM_, je kunt hebben Natural Docs negeren ze zo CCAT, CDog en CMouse verschijnen in C, D en M in plaats van alle onder C. Program in hoge mate geautomatiseerd: · Natural Docs detecteert welke delen van uw source tree verandering en de documentatie dienovereenkomstig aan te passen. Het zal automatisch in stand houden en het organiseren van het menu als je het niet zelf doet. Het zal automatisch de documentatie weer op te bouwen als opdrachtregel of configuratiebestand veranderingen vereisen. Differential bouwproces: · Natural Docs bouwt alleen de bestanden die zijn gewijzigd of toegevoegd sinds de laatste run en de bestanden die daarvan afhankelijk zijn, runtime drastisch verminderen en daardoor geschikt voor grotere projecten. Extensible Architectuur: · Natural Docs is ontworpen om gemakkelijk worden uitgebreid voor verschillende programmeertalen, onderwerpen, en CSS-stijlen, die allemaal zijn gedocumenteerd op deze site. Intelligent configuratiebestanden: · Natural Docs detecteert wijzigingen die u in de configuratiebestanden en zal zich bezighouden met de kleinere details zelf. Ze automatisch opnieuw formatteren zodat u quick-and-dirty wijzigingen kunt aanbrengen en nog steeds de leesbaarheid. Project configuratiebestanden houden een up-to-date lijst van de dingen die in de belangrijkste bestanden, zodat je weet wat je kunt overschrijven zonder hen te raadplegen. Draagbaar: · Natural Docs loopt overal Perl loopt, en dat is heel veel plaatsen. Vrij en Open: · Natural Docs is gelicenseerd onder de GPL, dus er is geen toeslag en u kunt experimenteren met de bron naar hartelust.


Natuurlijke documenten Gerelateerde software

Qmmslog

QMMSLOG - PORT VAN HET LOG4J VAN HET JAKARTA PROJECTEN NAAR QT / C ++ ...

162 192 KB

Downloaden