PBS logo: a tiny ninja with a pale face surrounded on either side by two squiggly brackets denoting programming. Get it? Ninja is stealthy!

CCATP #710 – Bart Busschots on PBS 132 of X — Managing JSDoc

In this final Programming By Stealth and final Chit Chat Across the Pond for 2021, Bart teaches us how to manage our documentation in JSDoc. As any good programmer, he insists on automating as much as he possibly can. He starts by showing us each step that we have to do at the command line, and methodically puts together a JSDoc configuration file that runs scripts and helps create documentation directories, and installs plugins.

Even better he helps us to configure JSDoc so that it will alert us if we make a mistake in our inline or block tags, since JSDoc by default just ignores those mistakes. Finally we walk through three different themes for our documentation and we actually choose one for the XKPASSWD project and he shows us how we can even modify the theme. It all has to do with Bart preferring blue over purple.

It’s great fun, and really gives us the tool we need now to get ready for the next step. You can follow along with Bart’s fabulous tutorial show notes pbs.bartificer.net.

mp3 download

Leave a Reply

Your email address will not be published. Required fields are marked *

Scroll to top