search

RyanLinrm / CSC473Project

A HTML5 Game developing project
4 stars 4 forks source link

Look into documentation #126

Closed RyanLinrm closed 5 years ago

RyanLinrm commented 5 years ago

https://docusaurus.io/ or jsdoc are the suggetstion source from professor

nmaswood98 commented 5 years ago

I looked into docusarus and JSDoc. I believe that JSDoc would be better because of the auto generation based on the comments. We can also write the doc as we write new functions which would be very good as we expand the project.

nmaswood98 commented 5 years ago

I installed JSDoc and began to document the the player class. Install js doc using "npm install jsdoc - g". And then use the command inside the folder "jsdoc -c jsdoc.json".

To look at the documentation look inside the doc folder and open the index.html file.