Навыки typescript-jsdoc

📦

typescript-jsdoc

Name: typescript-jsdoc
Author: AdamManuel-dev

Ревизия содержимого r1 Безопасно ⚙️ Внешние команды🌐 Доступ к сети

Документирование TypeScript API с помощью JSDoc

Команды, работающие с TypeScript, часто пишут комментарии, которые повторяют типы или упускают важное поведение. Этот навык помогает создавать сфокусированную JSDoc-документацию для API, примеров, ошибок и заметок по сопровождению.

Поддерживает: Claude Codex Code(CC)

🥉 79 Бронза

Установить с помощью моего Агента

Скопируйте этот запрос в своего Агента. Он содержит каноническую страницу Skill и манифест.

Запрос агента

Review the Skillstore skill "typescript-jsdoc" from https://skillstore.io/skills/adammanuel-dev-typescript-jsdoc.md and its manifest at https://skillstore.io/api/skills/adammanuel-dev-typescript-jsdoc/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

Ваш Агент по-прежнему должен показать план и запросить все подтверждения, требуемые политикой безопасности.

Ресурсы для AI-агентов

Используйте эти ссылки, когда AI-агенту, crawler или script нужен чистый контекст вместо полной страницы.

Markdown-детали GET /skills/adammanuel-dev-typescript-jsdoc.md Подписанный manifest GET /api/skills/adammanuel-dev-typescript-jsdoc/manifest Подписанный lockfile GET /api/skills/adammanuel-dev-typescript-jsdoc/lockfile

Протестировать

Использование «typescript-jsdoc». Метод публичного сервиса аутентификации с ошибками входа и поведением повторных попыток.

Ожидаемый результат:

Результат объясняет назначение сервиса, ожидаемые учетные данные, возможные ошибки аутентификации и сети, а также короткий пример использования.

Использование «typescript-jsdoc». Обобщенная вспомогательная функция, которая удаляет дублирующиеся элементы из массива.

Ожидаемый результат:

Результат документирует параметр типа, правило уникальности, необязательную функцию идентификатора и поведение возвращаемого массива.

Использование «typescript-jsdoc». Простой форматтер с комментариями, которые повторяют типы TypeScript.

Ожидаемый результат:

Результат рекомендует удалить избыточные описания параметров и оставить только полезное намерение отображения или примеры.

Аудит безопасности

Безопасно

v8 • 06.07.2026 Открыть версионный отчет

All static findings are false positives caused by Markdown code fences, inline TypeScript identifiers, and static documentation examples. I found no prompt injection, malicious intent, command execution, network access, secret access, or reconnaissance behavior in SKILL.md or patterns.md.

Просканировано файлов

439

Проанализировано строк

Пункты проверки

Ложные срабатывания проигнорированы

Факторы риска

Последний завершенный статический и семантический аудит не обнаружил подтвержденных проблем безопасности. Это не доказывает отсутствие побочных эффектов у навыка.

Аудитор:: codex Посмотреть историю аудитов →

Поделиться и цитировать этот отчет

Делитесь версионным отчетом об оценке, нейтральным значком, встраиваемой карточкой и цитатами. Skillstore публикует доказательства, не решая, безопасен ли этот Skill.

Открыть версионный отчет

Копировать ссылку на отчёт

https://skillstore.io/skills/adammanuel-dev-typescript-jsdoc/audits/8?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Значок Markdown

[![Skillstore security assessment](https://skillstore.io/badges/skills/adammanuel-dev-typescript-jsdoc/security.svg)](https://skillstore.io/skills/adammanuel-dev-typescript-jsdoc?utm_source=security_passport_badge)

Значок HTML

<a href="https://skillstore.io/skills/adammanuel-dev-typescript-jsdoc?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/adammanuel-dev-typescript-jsdoc/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

Встраиваемая карточка

<iframe src="https://skillstore.io/embed/skills/adammanuel-dev-typescript-jsdoc.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>

Академические ссылки (APA · BibTeX · CFF)

Цитата APA

AdamManuel-dev. (2026). typescript-jsdoc security audit report (audit version 8) [Author version unspecified]. Skillstore. https://skillstore.io/skills/adammanuel-dev-typescript-jsdoc/audits/8

Цитата BibTeX

@techreport{adammanuel-dev-adammanuel-dev-typescript-jsdoc-2026,
  author = {AdamManuel-dev},
  title = {typescript-jsdoc security audit report (audit version 8)},
  institution = {Skillstore},
  year = {2026},
  number = {8},
  url = {https://skillstore.io/skills/adammanuel-dev-typescript-jsdoc/audits/8},
  note = {Author version unspecified}
}

CITATION.cff

cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "typescript-jsdoc security audit report (audit version 8)"
version: "unspecified"
type: report
authors:
  - name: "AdamManuel-dev"
date-released: "2026-07-06"
url: "https://skillstore.io/skills/adammanuel-dev-typescript-jsdoc/audits/8"
identifiers:
  - type: other
    value: "skillstore:adammanuel-dev-typescript-jsdoc:audit:8"
    description: "Skillstore immutable audit report identifier"

Оценка Skillstore

Почему такая оценка Достоверность доказательств: Высокий

Архитектура

Сопровождаемость

Контент

Сообщество

Соответствие спецификации

Что вы можете построить

Документирование API публичной библиотеки

Создавайте понятную JSDoc-документацию для экспортируемых функций, классов и интерфейсов перед выпуском.

Прояснение сложного кода приложения

Добавляйте комментарии, которые объясняют повторные попытки, кэширование, ошибки, побочные эффекты и ограничения использования.

Проверка качества комментариев

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

Попробуйте эти промпты

Добавить базовый JSDoc

Добавь краткую JSDoc-документацию к этой функции TypeScript. Сфокусируйся на назначении, параметрах, возвращаемом значении и любых важных пограничных случаях.

Документировать публичный API

Проверь этот экспортируемый TypeScript API и напиши JSDoc, который объясняет поведение, ошибки и один практический пример использования.

Улучшить существующие комментарии

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

Разработать стандарт документации

Создай стандарт TypeScript JSDoc для этой кодовой базы. Включи обязательные теги, необязательные теги, анти-паттерны и критерии ревью.

Лучшие практики

Документируйте публичные API, экспортируемые модули, сложное поведение, ошибки и стабильные контракты использования.
Используйте JSDoc, чтобы объяснять, почему код ведет себя определенным образом, а не только то, что показывают типы.
Поддерживайте примеры в актуальном состоянии при изменении поведения, побочных эффектов, производительности или условий ошибок.

Избегать

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

Часто задаваемые вопросы

Генерирует ли этот навык JSDoc для кода TypeScript?

Да. Он помогает AI-агенту писать краткую JSDoc-документацию, которая объясняет поведение, использование, ошибки и примеры.

Поддерживает ли он обобщенные функции?

Да. Он охватывает использование @template и объясняет, как параметры типа влияют на входные данные, выходные данные и поведение.

Может ли он документировать React-компоненты?

Да. Справочные материалы включают документацию props компонентов и примеры поведения редактируемых компонентов.

Будет ли он запускать команды или обращаться к внешним сервисам?

Нет. Навык представляет собой рекомендации по документации, хранящиеся в Markdown-файлах, и не включает исполняемые скрипты.

Как он избегает избыточных комментариев?

Он рекомендует пропускать комментарии, которые только повторяют типы TypeScript и имена функций.

Подходит ли он для приватных кодовых баз?

Да. Он может помогать со стилем документации, но пользователям все равно следует соблюдать внутренние правила ревью и конфиденциальности.

Сведения для разработчиков

Автор

AdamManuel-dev

Лицензия

MIT

Ревизия Skillstore

Примечание о версии

Автор не указал версию.

Репозиторий

https://github.com/AdamManuel-dev/claude-code-ext/tree/main/skills/jsdoc

Ссылка

c1fdca50ff516318f65fed0d7f9e82797c5171dc

Актуальность поддержки

18.07.2026

Использование

7 загрузок · 253 просмотров

Структура файлов

📄 patterns.md

📄 SKILL.md