roqueando/konarium.io

No readable code docs

Opened this issue · 0 comments

A few comments don't follow the same pattern, so to read, it comes more hard, they sometimes come like this:

/**
 * Says hi to a person.
 * @param  {String} Person   The person that I'll say hi.
 * @return {String}                 The formated string
 */
function SayHi (Person) {
     return (`Hi, ${Person}`);
}

And sometimes like this:

 * -----------------------
 *    SayHi Function     |
 * -----------------------
 */
function SayHi (Person) {
     return (`Hi, ${Person}`);
}

A few methods are basic, so there's anything to say about comments inside them. But the more complex, such as DatHandle.sync () for example... Is simple to know what it does, just is hard to get what's happening inside it.

So, keep simple the docs and the same pattern and the same inside the methods.