oguzzkilic / vscode-undoc

An extention that detects undocumented functions and generates docs

Home Page:https://marketplace.visualstudio.com/items?itemName=yilmaztekinozer.undoc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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 extention that detects undocumented functions and generates docs

https://marketplace.visualstudio.com/items?itemName=yilmaztekinozer.undoc


Languages

Language:JavaScript 100.0%