vscode-undoc

A document generator for Function Expressions, Function Statements, Arrow Function Expressions, and Class Definitions.

It detects undocumented functions and class methods in your Javascript / Flow / React source code on the AST nodes at the compile stage. It collects passed parameters, return expressions, states for React code then it creates document template just above the functions.

Usage

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

CMD + Shift + P -> Create Docs

Install

undoc

React Example

Flow Example

Supports

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

Contribution

Feel free to open issues and PRs. You can look here for more details.

1. Fork it (https://github.com/oyilmaztekin/vscode-undoc/fork)
2. Create your branch (git checkout -b fix/issue-id)
3. Commit your changes (git commit -am 'Fixed something...')
4. Push the branch (git push origin fix/issue-id)
5. Create a new Pull Request

TODO

1. Cursor Interaction in the editor
2. Currying functions

Thanks

• babel