Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add code documentation #68

Open
katjaq opened this issue Oct 13, 2017 · 0 comments
Open

add code documentation #68

katjaq opened this issue Oct 13, 2017 · 0 comments

Comments

@katjaq
Copy link
Collaborator

katjaq commented Oct 13, 2017

MicroDraw uses docjs – without any installation this will output code comments into a documentation of all the functions.
For this to work, we have to put comments in the following style before every single function

/**
 * @function nameOfTheFunction
 * @desc Description of what the function does.
 * @param {type} varName Description of the variable that the function takes as input argument.
 * @returns {type} What the function returns.
 */

and here starts the function

type can be things like {object} or {string} or {number} or {boolean}

We have already put some comments into the code, but there are far more to go! :)

The code documentation is then immediately updating from the inserted comments and visible at
http://localhost:3000/doc/code.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant