Jsdoc Markdown Plugin

Using JSDoc tags# You can use the following JSDoc tags when documenting components, props and methods: @deprecated; @see, @link; @author; @since; @version; When documenting props you can also use: @param, @arg, @argument; All tags can render Markdown.

Good documentation doesn’t come easy

Jsdoc Markdown Plugin Not Working

• JSDoc is an open source API documentation generator for Javascript. It allows developers to document their code through comments.
• Template Based Scaffolding Tool for PostgreSQL.

Documenting source code is rarely something a coder likes to do. I’m just as guilty as anyone else. I know it’s a “good thing”, but my natural inclination is to code first and document later. Sometimes later comes so late that it’s a chore to get it done. I’ve been forcing myself to document as I go, and it usually works out pretty well in the end.

I’m a control freak

Jsdoc Markdown Template

What’s made this process easier for me is to completely dump the notion of auto-generated documentation (I’m looking at you, javadoc, jsdoc, yuidoc, ruby-doc and the like). Instead, I favor writing the documentation for a given piece of code with markdown.