Skip to content
/ vscode-undoc Public

An extension that detects undocumented functions and methods at the compile stage then generates its docs.

marketplace.visualstudio.com/items?itemname=undoc.undoc
4 stars 1 fork Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

oyilmaztekin/vscode-undoc

BranchesTags

Repository files navigation

vscode-undoc

An documentation generator for JavaScript functions and class methods. It detects undocumented functions and class methods in your Javascript / Flow / React file and creates a documentation template above the function or method.

Usage

Using Command Palette (CMD/CTRL + Shift + P)

CMD + Shift + P -> Create Docs

React Example

react-example

Flow Example

flow-example

Supports

  1. ES 6
  2. Presets of React
  3. Presets of Flow
  4. States ( only initialized in the constructor )

Contribute

Feel free to open issues and PRs. You can look here for helper documentations.

TODO

1- Create doc with selecting function or method 2- Currying function 3- PropTypes

About

An extension that detects undocumented functions and methods at the compile stage then generates its docs.

marketplace.visualstudio.com/items?itemName=undoc.undoc

Resources

Readme
Activity

Stars

4 stars

Watchers

1 watching

Forks

1 fork
Report repository

Releases 2

0.0.10 Latest
Nov 2, 2018
+ 1 release

Packages

No packages published

Contributors 2

  •  
  •  

Languages