Navigatie

Class documentatie generator Scripts & projects

De class genereert aan de hand van de door de scripter opgegeven commentaar een nette overzichtelijk documentatie van een php-class. Werken met classes en documenteren van classes hoeft op deze manier minder tijdrovend te zijn.
Talen:
html, php
Oplevering:
Winter 2005
Website / url:
Class documentatie generator
Class documentatie generator
Het doel was het maken van een hanteerbaar naslagwerk voor bruikbare php-classes, waarmee een class eenvoudig gedocumenteerd kan worden door onder andere mijzelf, maar ook scripters die eventueel met dezelfde classes moeten werken. De source van een class kan verschillen van 50 regels tot 750 regels, afhankelijk van de flexibiliteit van de class maar ook het systeem waarvoor een class ontwikkelt is.

De meest belangrijke en dus meeste functies werken met elkaar samen en zijn om die reden in een zogenaamde class geplaatst. Deze classes zorgen ervoor dat een systeem nog dynamischer is en flexibel tegenover aanpassingen kan staan. Allerlei gegevens worden in de classes verwerkt en worden gewenste materiaal gegenereerd. Dit zorgt er voor dat er een soort eenheid wordt gecreeërd in bepaalde situaties, voor deze situaties kunnen acties, meldingen en dergelijke dus vanaf één punt veranderd worden. Dit zorgt er dus op zijn beurt voor dat gebruikers uniformaliteit tegemoet kunnen zien en programmeurs geen dagtaak kwijt zijn om de werking van een systeem te veranderen.