Добавление примеров реального кода в документацию JSDoc

В JSDoc вы можете добавлять в документацию реальные примеры кода, чтобы обеспечить четкие и краткие объяснения ваших методов JavaScript. Включение фрагментов кода помогает разработчикам понять использование и поведение ваших функций. Вот несколько методов, которые вы можете использовать для добавления реального кода в документацию JSDoc:

  1. Блоки встроенного кода.
    Используйте обратные кавычки (`), чтобы заключить встроенный код в комментарии к документации. Например:

    /
    * Calculates the sum of two numbers.
    *
    * @param {number} a - The first number.
    * @param {number} b - The second number.
    * @returns {number} The sum of the two numbers.
    *
    * @example
    * // Usage example:
    * const result = add(2, 3);
    * console.log(result); // Output: 5
    */
    function add(a, b) {
     return a + b;
    }
  2. Блоки кода.
    Используйте тройные обратные кавычки («`) для создания блоков кода для более крупных фрагментов кода. Например:

    /
    * Performs a linear search on the given array and returns the index of the target element.
    *
    * @param {Array} array - The array to search.
    * @param {*} target - The element to search for.
    * @returns {number} The index of the target element, or -1 if not found.
    *
    * @example
    * // Usage example:
    * const arr = [1, 2, 3, 4, 5];
    * const targetIndex = linearSearch(arr, 3);
    * console.log(targetIndex); // Output: 2
    */
    function linearSearch(array, target) {
     for (let i = 0; i < array.length; i++) {
       if (array[i] === target) {
         return i;
       }
     }
     return -1;
    }

Включая эти примеры кода в документацию JSDoc, вы предоставляете разработчикам практические сценарии использования и помогаете им понять, как эффективно использовать ваш код.