VSCode JSDoc 自動文字到區塊註解轉換工具      

一個幫助工具,用於使用 @example 標籤快速解決 JSDoc 文字換行問題,適用於 JavaScript/TypeScript
輸入文字自動產生評論 (Text)
⇊⇊⇊
⇈⇈⇈
輸入註解自動恢復文字 (Comment)

VSCode / Cursor JSDoc:增強 JavaScript 文檔


JSDoc - Wikipedia
JSDoc 是一個強大的 JavaScript 文件產生器。它使用特殊格式的註釋為您的程式碼建立詳細的 API 文件。透過將 JSDoc 註解新增至 JavaScript 檔案中,您可以提供有關函數、類別和模組的清晰且結構化的資訊。

JSDoc 的主要特點:

類型資訊
函數參數和返回值
類別和方法描述
模組文檔
JSDoc 中一個特別有用的標籤是@example 標籤。該標籤允許您在文件中包含程式碼範例。我們的工具與眾不同之處在於它能夠在 @example 標記內保留格式、縮排和換行符。這意味著您可以編寫更具可讀性和現實性的程式碼範例,使開發人員更容易理解如何使用您的函數或類別。

用法範例:
/**
 * Calculates the sum of two numbers.
 * @param {number} a - The first number.
 * @param {number} b - The second number.
 * @returns {number} The sum of a and b.
 * @example
 * // This example preserves formatting and line breaks
 * const result = add(5, 3);
 * console.log(result);
 * // Output: 8
 */
function add(a, b) {
    return a + b;
}
透過使用我們的線上 JSDoc 註釋產生器,您可以輕鬆建立格式良好的文檔,其中包括程式碼範例中保留的格式,使您的 JavaScript 文件更加清晰和有效。