info/developer-roadmap
1
0
Fork 0
mirror of https://github.com/kamranahmedse/developer-roadmap.git synced 2025-08-29 12:10:22 +02:00
Code Issues Releases Wiki Activity

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

Browse Source
This commit is contained in:
Ruslan Semagin
2024-07-05 11:49:40 +03:00
committed by GitHub
parent 485b3d5c9a
commit afb0da4bd6
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/data/roadmaps/rust/content/121-rustdoc.md
View File

@@ -1,3 +1,7 @@
# Documenting with `rustdoc` # 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)