Julie Ng

Julie Ng

← Work

JSDoc Template - tidy

Developers spend a lot of time reading documentation. Well designed documentation lets developers find answers and deliver business value faster.

Especially when debugging unexpected results, API documentation is key and where programmers spend a lot of time, myself included. I write a lot of modular JavaScript for internal projects and created this template autogenerate useful documentation.

The template includes unique typography for:

  • Optional Values
  • Types, e.g. string, array, etc.
  • Parameters
  • Methods
  • Default values
  • Nested values

This template is used in internal projects. But I published it on npm anyway.

View on NPM →

Screenshots

View on NPM →

← Case Studies