1

Onderwerp: Tools voor documentatie van je code

Op dit moment heb ik nog geen vaste manier om mijn javascript code te documenteren en om automatisch een styleguide te kunnen maken van mijn CSS bestanden. Ik wil dit nu wel gaan doen zodat andere mensen ook verder kunnen werken aan code die ik gemaakt heb.

Dus de vraag is: Wat voor tools gebruiken jullie voor documentatie van javascript en/of css? smile

2

Re: Tools voor documentatie van je code

Ik ben bezig om JavaScript te leren, vooral veel lezen en af en toe wat code uitproberen, maar ik heb mijn commentaren in de JsDoc (http://usejsdoc.org/) stijl geplaatst.

/**
 * @function
 * @name listSVGlayers
 * @description Search for the layers in a SVG file and return their IDs in a list
 * @requires jquery
 * @param {string} SVGid ID of <object> holding the SVG file
 * @returns {string[]} layersList_json List of layer ID's, in JSON format
 * @returns {null} SVGid not found or no layers with an ID found
 */
History repeats itself.
It has to,
nobody is listening!

3

Re: Tools voor documentatie van je code

Ik gebruik hier zelf geen tools voor. Maar je hebt het over het automatisch genereren van een styleguide, dan moet je eens kijken naar KSS (Knyle Style Sheets): https://github.com/kneath/kss/blob/master/SPEC.md

Dit is een manier van CSS documenteren en met een ruby library kun je hier een living style guide van maken.

4

Re: Tools voor documentatie van je code

Ik ben ook voor JsDoc. Editors als Aptana en Sublime bieden hiervoor ondersteuning en de documentatie is in een buildproces met bv. Ant of Maven te genereren.