JSDoc

  1. ¿Cual es la sintáxis de los comentarios de documentación en JSDoc? ¿Como empiezan?
  2. ¿Donde debo ubicar un comentario de documentación JSDoc para documentar un cierto código?
  3. Special JSDoc tags can be used to give more information. For example,

    1. If the function is a constructor for a class, you can indicate this by adding a __ tag (fill the gap)
    2. ¿Cómo se documenta un parámetro de una función?
    3. ¿Que hace esta documentación JSDoc?

       /**
        * See {@tutorial gettingstarted} 
        */
       function myFunction() {}
      
    4. ¿Que hace esta documentación JSDoc?

       /**
        * See {@link MyClass} and [MyClass's foo property]{@link MyClass#foo}.
        * Also, check out {@link http://www.google.com|Google} and
        * {@link https://github.com GitHub}.
        */
       function myFunction() {}