Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Deno 2.x] Implement testable code examples directly in comments #2

Open
zhorton34 opened this issue Oct 2, 2024 · 0 comments
Open

[Deno 2.x] Implement testable code examples directly in comments #2

zhorton34 opened this issue Oct 2, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@zhorton34
Copy link
Owner

Doc tests with deno test --doc
JSDoc is a format for writing inline documentation for JavaScript and TypeScript. It’s how deno doc and JSR automatically generate documentation for its modules.

JSDoc allows us to write code examples directly in comments:
@zhorton34 zhorton34 added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@zhorton34