Skip to content
This repository was archived by the owner on Aug 8, 2020. It is now read-only.
This repository was archived by the owner on Aug 8, 2020. It is now read-only.

Decide if we should use JSdocs #129

@ghost

Description

@Mondei1 We should decide on if we want to make use of the JSdoc-commenting.

/**
 * Extracts the user ID out of the JWT
 * @param jsonwebtoken JWT of user
 * @returns ObjectID of user
 */

This is nice, but i am not sure if this is needed, since our software will never be used by other people. It's not a package that is embedded somewhere, so other pserson needs to read our functions...
I can just imagine that it would be nice for ourselfes to have more information, but keeping JSdocs in sync with the rest of the code requires extra work.... And i'm not sure if the Typescript-"documentation" is maybe enough at this point.

I mean...

export async function addUserToRequest(req: ModifiedRequest, res: Response, next: Function): Promise<void> {

This is pretty straight forwarded and easy to understand in my opinion^^

Not saying i'm against JSdocs, i just think weshould decide on if to use it or not and then make the code consistent :)

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestquestionFurther information is requested

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions