https://github.com/mooz/js-doc

Insert JsDoc style comment easily in Emacs
https://github.com/mooz/js-doc

Last synced: about 1 month ago
JSON representation

Insert JsDoc style comment easily in Emacs

• Host: GitHub
• URL: https://github.com/mooz/js-doc
• Owner: mooz
• Created: 2009-08-19T04:35:44.000Z (over 15 years ago)
• Default Branch: master
• Last Pushed: 2017-06-09T12:26:04.000Z (over 7 years ago)
• Last Synced: 2024-08-07T18:31:48.369Z (5 months ago)
• Language: Emacs Lisp
• Homepage:
• Size: 26.4 KB
• Stars: 60
• Watchers: 4
• Forks: 19
• Open Issues: 15
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# js-doc

Insert JSDoc style comment easily in Emacs

## Installation

1. Put `js-doc.el` somewhere in your emacs load path.

2. Add a line below to your .emacs file:

```scheme

(require 'js-doc)

```

## Example

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

## Configuration

```scheme

(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)))

```