Code Documentation (functions, classes, etc)

RitsuProject / ritsu-v3

📚 Next version of Ritsu totally rewritten in Typescript and Eris.

MIT License

5 stars 3 forks source link

Code Documentation (functions, classes, etc) #47

Closed Sazzo closed 3 years ago

Sazzo commented 3 years ago

As in V2, it is good to try to document each function or class so that the understanding of the code is better, I have already done this in some classes but I think they can still be improved.

One solution to this would be JSDocs.

Lioness100 commented 3 years ago

https://www.npmjs.com/package/typedoc is another good option :)

Sazzo commented 3 years ago

Basically made this on 0d375ea, I'll dont try to add comments on everything and instead I think its better to just follow the argument that "less comments = better code" and because of this, I refactored a bunch of things.