This week’s Chit Chat Across the Pond is another installment of Programming By Stealth with Bart Busschots. In our last installment, Bart explained why good documentation matters to ourselves and to other developers who want to use our code, and he also explained that using an automatic document generator like JSDoc could help make it easier for us to write good documentation and to keep it up to date more easily.
In this week’s installment, he starts to show us how to actually write JSDoc comments in line with our code. He explains the different elements of JSDoc comments and demonstrates how his own doc comments evolve as he figures out what he’s trying to do. I really enjoyed this installment and his example is perfect for us nerds.
I highly recommend you follow along in Bart’s fabulous tutorial shownotes at pbs.bartificer.net