VSCode JSDoc テキストをブロックコメントに自動変換するツール

@example タグを使用して JSDoc テキストの改行をすばやく解決するための JavaScript/TypeScript 用ヘルパー ツール

テキストを入力するとコメントが自動的に生成されます (Text)

Line TrimNO [/**] and NO [**/]

⇊⇊⇊

⇈⇈⇈

コメントを入力するとテキストが自動的に復元されます (Comment)

VSCode / Cursor JSDoc: JavaScript ドキュメントの強化

JSDoc - Wikipedia

JSDoc は、JavaScript 用の強力なドキュメント ジェネレータです。特別にフォーマットされたコメントを使用して、コードの詳細な API ドキュメントを作成します。JavaScript ファイルに JSDoc コメントを追加することで、関数、クラス、モジュールに関する明確で構造化された情報を提供できます。

JSDoc の主な機能:

型情報
関数のパラメーターと戻り値
クラスとメソッドの説明
モジュールのドキュメント
JSDoc で特に便利なタグの 1 つは @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 ドキュメントがより明確で効果的になります。

ホーム VSCode ツール

VSCode コードからスニペットへの変換ツール VSCode カーソル JSDoc テキストをブロックコメントに変換する自動ツール