Styles Guide

openapi-docs

Docstrings

Routes

   /**
    Description:
    Associated Endpoint: (for example: /authors/:authorid)
    Request Type:
    Request Body: (for example: { username: 123, email: [email protected] })
    Return: 200 Status (or maybe it's a JSON, specify what that JSON looks like)
    */

Backend + Frontend

/**
 * Description: Represents a Comment 
 * Functions: 
 *     - functionName(): Sends a DELETE request to delete a comment on a specific post 
 * Returns: 
 */
console.log('Debug: <TLDR what the function is doing>')

/**
 * Description:  
 * Request: (if axios is used)    
 * Returns: 
 */
console.log('Debug: <TLDR what the function is doing>')