link to article 'How to write documentation' in 'Rust' (#6058)

pull/6059/head
Ruslan Semagin 5 months ago committed by GitHub
parent 485b3d5c9a
commit afb0da4bd6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 6
      src/data/roadmaps/rust/content/121-rustdoc.md

@ -1,3 +1,7 @@
# Documenting with `rustdoc`
`rustdoc` is a tool that comes bundled with Rust by default. It is primarily used to generate documentation for Rust projects. `rustdoc` takes into consideration both the comments and the source code to produce comprehensive documentation. The resultant documentation can be viewed through a web server or a web browser. The uniqueness of `rustdoc` lies in its testing feature. It can test the code snippets present in your documentation, ensuring that your examples are accurate and up-to-date. It is the de facto tool for all Rust developers to create and maintain their project documentation.
`rustdoc` is a tool that comes bundled with Rust by default. It is primarily used to generate documentation for Rust projects. `rustdoc` takes into consideration both the comments and the source code to produce comprehensive documentation. The resultant documentation can be viewed through a web server or a web browser. The uniqueness of `rustdoc` lies in its testing feature. It can test the code snippets present in your documentation, ensuring that your examples are accurate and up-to-date. It is the de facto tool for all Rust developers to create and maintain their project documentation.
Visit the following resources to learn more:
- [@article@How to write documentation](https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html)

Loading…
Cancel
Save