技能 编程开发 Effect JSDoc 文档编写

Effect JSDoc 文档编写

v20261120
effect-smol-jsdocs
基于声明、实现、调用点与 doctest 证据,编写和审查 Effect 公共 API 的 JSDoc 文档,涵盖标签分类、可运行示例、链接与相关 API 审计,并通过仓库 JSDoc 检查器验证。
获取技能
364 次下载
概览

Document Effect Public APIs

When to Use

Write or review Effect public JSDoc against declaration, implementation, call-site and doctest evidence.

Workflow

Read the declaration, implementation, public types and real call sites. Follow the project's current tags, categories and example rules. Write a practical description and add usage, details or concrete gotchas where needed. Audit links and related APIs. Compile runnable examples through the targeted doctest and run the repository's JSDoc checker. Keep internal or unsupported declarations out of public API docs.

Example

Document a public combinator with one runnable error-handling example and a verified link to its nearest alternative.

Limitations

Requires the relevant Effect workspace and its versioned tools. Use local project policy and authorized fixtures. Results cover only the checked packages and environments.

Bundled resources

Use the bundled local references for the applicable branch of the workflow: categories, declarations, examples. Run commands against the target Effect workspace.

Source

Adapted from the pinned skill tree. See the MIT license.

This snapshot of Effect v4 is vendored by Local Studio.

信息
分类 编程开发
名称 effect-smol-jsdocs
版本 v20261120
大小 4.82KB
更新时间 2026-11-21
语言