deno_doc

一个用于生成 JavaScript 和 TypeScript 模块文档的 Rust 包。

此包为 deno doc 提供支持，但不仅限于 Deno，也可以用于编写针对其他目标（如 Node 或浏览器）的文档生成器。

从 Deno CLI 或部署使用

参阅 js/README.md。

Rust 示例

examples/ddoc/main.rs 提供了一个最小化的独立二进制文件，演示了如何将 deno_doc 作为包使用。

$ cargo run --example ddoc ../deno_std/http/mod.ts

开发

# build all targets
$ cargo build --all-targets

# test it
$ cargo test

# build js api
$ deno task build

# test it
$ deno task test

我们使用 insta 测试工具来捕获 html 输出的快照。如果您更改了 html 输出的渲染，或更改了 html 测试的固定文件，您需要使用 cargo-insta 命令更新快照。

# update snapshots
cargo insta test

# review snapshots
cargo insta review

有关更多详细信息，请参阅 insta 文档。

贡献

• 如果您打算处理一个问题，请在开始处理问题之前在问题评论中提及。

• 请在论坛中保持专业。查看我们的行为准则。

• 在社区聊天室中寻求帮助。

提交拉取请求

在提交之前，请确保以下事项已完成

1. 存在相关问题，并且在PR文本中引用了该问题。
2. 有测试覆盖了更改。
3. 确保cargo test和deno task test通过。
4. 使用rustfmt --check src/lib.rs格式化您的代码
5. 确保cargo clippy --all-targets --release --locked -- -D clippy::all通过。