Resurser på webben: Dokumentera Javascript-kod

De som har velat dokumentera projekt som innehåller större mängder Javascript-kod har tidigare varit hänvisade till http://usejsdoc.org. Nu finns alternativ. Sphinx är en lösning som skapades i syfte att dokumentera Python-kod och nu finns även stöd för Javascript. Någon har kommenterat att Sphinx är verktyget som får utvecklare att vilja dokumentera koden, bara en sådan sak.

Sphinx kan fås att generera dokumentation i en mängd olika format. Dokumentationen blir rikligt korslänkad för bland annat funktioner och klasser. Du kan även definiera en struktur bland filerna som också korslänkas.

Totalt finns över 50 tillägg som installeras med hjälp av PyPI.

Du installerar Sphinx från PyPI, Github eller Npm. Därefter kan du köra kommandot ”quickstart” som sätter upp allt efter att du har svarat på några frågor. Du måste också sätta upp tillägget som Sphinx JS utgör, vilket sker i conf.py. Därefter kan du köra igång.

https://github.com/erikrose/sphinx-js

Av Patrik Brinkhäll

 

Den tryckta upplagan av Datormagazin har en fast avdelning kallad ”Resurser på webben”, där vi tipsar om intressanta lösningar på webben. Detta var en liten smak av föregående nummer 10 (nummer 11 finns i butik).

redaktionen

Om redaktionen

Datormagazin riktar sig till avancerade och intresserade datoranvändare och är även det enda magasinet i Sverige som har en fast sektion för bevakning av Linuxområdet men vi skriver om alla operativsystem.

Kommentera

*

Liknande artiklar