技能 typescript-jsdoc

📦

typescript-jsdoc

Name: typescript-jsdoc
Author: AdamManuel-dev

内容修订 r1 安全 ⚙️ 外部命令🌐 网络访问

使用 JSDoc 记录 TypeScript API

TypeScript 团队经常编写重复类型信息或遗漏重要行为的注释。此技能会指导你为 API、示例、错误和维护说明编写聚焦的 JSDoc。

支持: 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.

你的智能体仍应展示其计划，并按安全策略请求必要确认。

Agent 可读资源

当 AI Agent、爬虫或脚本需要干净上下文，而不是读取完整页面时，请使用这些链接。

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 • 2026/7/6 打开版本化报告

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

分析行数

复核项

已忽略误报

最新一次完成的静态与语义审计未检测到已确认的安全发现。这并不能证明该 Skill 没有副作用。

审计者: 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

为这个 TypeScript 函数添加简洁的 JSDoc。重点说明用途、参数、返回值以及任何重要的边界情况。

记录公共 API

评审这个导出的 TypeScript API，并编写 JSDoc 来解释行为、错误和一个实用的使用示例。

改进现有注释

审查这些 JSDoc 注释中的冗余内容。只保留解释意图、约束、副作用或用法的信息。

设计文档标准

为这个代码库创建一套 TypeScript JSDoc 标准。包括必需标签、可选标签、反模式和评审标准。

最佳实践

为公共 API、导出模块、复杂行为、错误和稳定的使用契约编写文档。
使用 JSDoc 解释代码为何以某种方式运行，而不只是说明类型已经展示的内容。
当行为、副作用、性能或错误条件发生变化时，保持示例最新。

避免

不要在没有提供有用上下文的情况下重复 TypeScript 类型信息。
不要记录在重构期间可能变化的不稳定实现细节。
当名称和类型已经能解释行为时，不要给显而易见的辅助函数添加冗长注释。

常见问题

此技能会为 TypeScript 代码生成 JSDoc 吗？

是。它会指导 AI 代理编写简洁的 JSDoc，用于解释行为、用法、错误和示例。

它支持泛型函数吗？

是。它涵盖 @template 的用法，并解释类型参数如何影响输入、输出和行为。

它可以记录 React 组件吗？

是。参考内容包括组件 prop 文档，以及可编辑组件行为的示例。

它会运行命令或访问外部服务吗？

不会。此技能是存储在 Markdown 文件中的文档指导，不包含可执行脚本。

它如何避免冗余注释？

它建议跳过那些只复述 TypeScript 类型和函数名称的注释。

它适合私有代码库吗？

是。它可以指导文档风格，但用户仍应遵守内部评审和保密规则。

开发者详情

作者

AdamManuel-dev

许可证

MIT

Skillstore 修订

版本提示

作者未声明版本。

仓库

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

引用

c1fdca50ff516318f65fed0d7f9e82797c5171dc

维护新鲜度

2026/7/26

使用量

8 次下载 · 253 次浏览

文件结构

📄 patterns.md

构建 Claude Code 斜杠命令

由 C0ntr0lledCha0s

团队需要易于调用和审查的可重复 AI 工作流。此技能可帮助创建、更新、验证和记录 Claude Code 斜杠命令。

编码与开发查看

typescript-jsdoc

使用我的智能体安装

Agent 可读资源

测试它

安全审计

风险因素

复制报告链接

Markdown 徽章

HTML 徽章

嵌入卡片

APA 引用

BibTeX 引用

CITATION.cff

Skillstore 评分

你能构建什么

记录公共库 API

阐明复杂应用代码

评审注释质量

试试这些提示

最佳实践

避免

常见问题

开发者详情

AdamManuel-dev 的更多技能

code-review

architecture-patterns

playwright-browser-automation

vitest-testing

router

相关技能

Plugin Structure

code-reviewer

analyzing-patterns

playwright-testing

building-agents

building-commands