Insert JsDoc style comment easily in Emacs
Switch branches/tags
Nothing to show
Clone or download
mooz Merge pull request #16 from blaenk/yasnippet-integration
implement js-doc-insert-function-doc-snippet
Latest commit f0606e8 Jul 15, 2016
Failed to load latest commit information. style: Correct typo in Feb 5, 2016
js-doc.el fix positioning Jul 13, 2016


Insert JSDoc style comment easily in Emacs


  1. Put js-doc.el somewhere in your emacs load path.
  2. Add a line below to your .emacs file:
(require 'js-doc)


Paste the codes below into your configuration file and you:

  1. insert function document by pressing Ctrl + c, i
  2. insert @tag easily by pressing @ in the JSDoc style comment

If you want to see the tag description, just input the next command M-x js-doc-describe-tag


(setq js-doc-mail-address "your email address"
       js-doc-author (format "your name <%s>" js-doc-mail-address)
       js-doc-url "url of your website"
       js-doc-license "license name")

 (add-hook 'js2-mode-hook
           #'(lambda ()
               (define-key js2-mode-map "\C-ci" 'js-doc-insert-function-doc)
               (define-key js2-mode-map "@" 'js-doc-insert-tag)))