DEV Community

Cover image for Stop Writing JSDoc Comments Manually
Chintan Goswami
Chintan Goswami

Posted on

Stop Writing JSDoc Comments Manually

Documentation is one of those things every team agrees is important, but almost nobody enjoys writing.

So I built JSDoc Scribe, an open-source npm package that automatically generates professional JSDoc comment blocks.

Why?

Because developers should focus on writing software, not repetitive comments.

Features

✅ Functions
✅ Classes
✅ Methods
✅ Interfaces
✅ Variables
✅ Constants
✅ TypeScript Support

Example

Before

function calculateTotal(items) {}
Enter fullscreen mode Exit fullscreen mode

After

/**
 * Calculates the total...
 *
 * @param items
 * @returns
 */
function calculateTotal(items) {}
Enter fullscreen mode Exit fullscreen mode

The project is still evolving, and I'd love your suggestions.

npm: https://www.npmjs.com/package/jsdoc-scribe

GitHub: https://github.com/imchintoo/jsdoc-scribe

Happy coding!

Top comments (0)