Категории

← View All Tools

Комментарии в PDF

Создает PDF документацию из комментариев

Извлекает комментарии JSDoc и создает PDF.

Ввод: код с /** */
Вывод: PDF

Примеры результатов

1 Примеры

Пример: Doc Comment Docs

Автоматически созданный PDF-пример: Source comments rendered as docs PDF

doc-comment-to-pdf-docs-example1.pdf Показать файл
Показать параметры ввода
{ "sourceText": "/**\n * Adds two values\n * @param {number} a\n * @param {number} b\n */\nfunction add(a,b){ return a+b }", "docTitle": "Utility Docs", "version": "1.0.0" }

Click to upload file or drag and drop file here

Maximum file size: 10MB Supported formats: text/plain, application/octet-stream

Ключевые факты

Категория
Document Tools
Типы входных данных
textarea, file, text, number, select, checkbox
Тип результата
file
Покрытие примерами
4
API доступен
Yes

Обзор

Инструмент для автоматического преобразования JSDoc-комментариев из вашего исходного кода в структурированный PDF-документ с описанием API.

Когда использовать

  • •Когда необходимо быстро создать техническую документацию на основе актуальных комментариев в коде.
  • •Для подготовки профессиональных PDF-отчетов по API для передачи коллегам или клиентам.
  • •Если требуется стандартизировать оформление документации без использования сложных систем сборки.

Как это работает

  • •Загрузите файл с исходным кодом или вставьте фрагмент кода с JSDoc-комментариями в поле ввода.
  • •Настройте параметры оформления: заголовок документа, версию, размер страницы и поля.
  • •Нажмите кнопку генерации, чтобы извлечь комментарии и получить готовый PDF-файл.

Сценарии использования

Создание справочника API для внутренних команд разработки.
Генерация сопроводительной документации к библиотекам и модулям.
Подготовка печатных версий технического задания на основе кода.

Примеры

1. Генерация документации API

Frontend-разработчик
Контекст
Разработчик завершил написание модуля обработки данных и хочет предоставить коллегам понятную документацию функций.
Проблема
Ручное написание документации занимает много времени и часто расходится с актуальным кодом.
Как использовать
Вставить код с JSDoc-комментариями в поле 'Исходный текст', указать заголовок 'API Модуля данных' и нажать кнопку генерации.
Пример конфигурации
docTitle: 'API Модуля данных', version: '1.0.0', pageSize: 'A4'
Результат
Готовый PDF-файл с отформатированным описанием функций, параметров и типов данных.

Проверить на примерах

pdf, text, file
PDF Примеры
PDF примеры, созданные инструментами 2026-02-01..2026-02-10
title token pdf
text
Примеры Комментариев Кода
Примеры кода с различными стилями комментариев для тестирования удаления комментариев
title token comment
text
Примеры Markdown Презентаций
Markdown колоды в стиле Remark/Marp для тестирования экспорта в PDF
preferred input family text
text
Образцы Документации Кода
Примеры кода с различными стилями документации, включая JSDoc, JavaDoc, docstrings Python и аннотации TypeScript
preferred input family text
text

Связанные хабы

Инструменты Pdf для Convert
Изучите 28 инструментов pdf для сценариев convert и быстро сравните близкие утилиты.
Инструменты Text для Convert
Изучите 80 инструментов text для сценариев convert и быстро сравните близкие утилиты.
Инструменты Text
Изучите 33 инструментов text для сценариев utility и быстро сравните близкие утилиты.
Инструменты Text для Analyze
Изучите 12 инструментов text для сценариев analyze и быстро сравните близкие утилиты.

FAQ

Какие форматы комментариев поддерживаются?

Инструмент предназначен для обработки стандартных JSDoc-комментариев, начинающихся с /** и заканчивающихся */.

Можно ли изменить ориентацию страницы?

Да, вы можете выбрать альбомную ориентацию в настройках перед генерацией документа.

Как настроить поля в итоговом PDF?

В разделе настроек доступны поля для ввода значений отступов в миллиметрах для каждой стороны страницы.

Нужно ли устанавливать дополнительное ПО?

Нет, инструмент работает полностью в браузере, вам не нужно ничего устанавливать.

Какой максимальный размер файла можно загрузить?

Вы можете загрузить файл размером до 10 МБ для обработки.

Документация API

Конечная точка запроса

POST /ru/api/tools/doc-comment-to-pdf-docs

Параметры запроса

Имя параметра Тип Обязательно Описание
sourceText textarea Нет -
sourceFile file (Требуется загрузка) Нет -
docTitle text Нет -
version text Нет -
baseFontSize number Нет -
pageSize select Нет -
landscape checkbox Нет -
printBackground checkbox Нет -
marginTop number Нет -
marginBottom number Нет -
marginLeft number Нет -
marginRight number Нет -
waitUntil select Нет -
waitTime number Нет -

Параметры типа файл должны быть загружены сначала через POST /upload/doc-comment-to-pdf-docs для получения filePath, затем filePath должен быть передан в соответствующее поле файла.

Формат ответа

{
  "filePath": "/public/processing/randomid.ext",
  "fileName": "output.ext",
  "contentType": "application/octet-stream",
  "size": 1024,
  "metadata": {
    "key": "value"
  },
  "error": "Error message (optional)",
  "message": "Notification message (optional)"
}
Файл: Файл

Документация MCP

Добавьте этот инструмент к конфигурации сервера MCP: 

{
  "mcpServers": {
    "elysiatools-doc-comment-to-pdf-docs": {
      "name": "doc-comment-to-pdf-docs",
      "description": "Создает PDF документацию из комментариев",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=doc-comment-to-pdf-docs",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Вы можете объединять несколько инструментов, например: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, максимум 20 инструментов.

Поддерживает ссылки на файлы URL или кодирование Base64 для параметров файла.

Если вы столкнулись с проблемами, пожалуйста, свяжитесь с нами по адресу [email protected]