reactjsdocumentationtypedoc

React hooks documentation generator


What is the best way to generate documentation for React hooks in .jsx and .tsx files?

I tried TypeDoc, but I do not get any comments from function methods.

const MainFunction = () => {

  /**
   * How to get generate this comment?
   * 
   * @param a first number
   * @param b second number
   * 
   * @returns sum of and b
   */
  const sumNumbers = (a, b) => {
    return a + b;
  }
}

Solution

  • I solved this with JSDoc and better-docs plugin.