やってみる

アウトプットすべく己を導くためのブログ。その試行錯誤すらたれ流す。

Rustのcargo(cargo docでドキュメント生成)

 ドキュメント用コメントの書き方も。

成果物

参考

ドキュメント用コメント

  • //!
  • ///

 内容はMarkdownで書く。

先頭

//! 本クレートについて
//! 
//!  このクレートは`cargo doc`を使ってみただけである。
//! 
//! * https://doc.rust-jp.rs/book/second-edition/ch14-02-publishing-to-crates-io.html

要素ごと

/// 1を加算した値を返す。
///
/// # 例
///
/// ```
/// assert_eq!(add_one(0), 1);
/// ```
pub fn add_one(x: i32) { x + 1 }

よく使われるセクション名

  • Examples: コード例
  • Panics: panic!する時
  • Errors: Result返却時
  • Safety: unsafeな時(その理由と、呼出元に保持しているべき不変条件)

ドキュメント生成

$ cargo doc --open

 HTMLファイルが生成される。ブラウザで開かれる。自動的に。

対象環境

$ uname -a
Linux raspberrypi 4.19.42-v7+ #1219 SMP Tue May 14 21:20:58 BST 2019 armv7l GNU/Linux

前回まで