【Rustを学ぶ】コメントとドキュメント生成

今回はコメントとドキュメント生成について試してみました。

作成したのは以下の、なんの変哲もないfizzbuzzのコードです。

//! Program: Fizzbuzz
//! author: hogehoge
//! date: xxxx/xx/xx

fn main() {
    fizz_buzz()
}

/// fizzbuzz 1 to 20
fn fizz_buzz() {
    let mut x = 1;

    while x <= 20 {
        if x % 15 == 0 {
            // output "FizzBuzz"
            println!("FizzBuzz");
        } else if x % 3 == 0 {
            // output Fizz
            println!("Fizz");
        } else if x % 5 == 0 {
            // output Buzz
            println!("Buzz");
        } else {
            // output number
            println!("{}", x);
        }
        x += 1;
    }
}

cargo run を行えばFizzBuzzが実行されてくれます。

さて、ここで試したかったのはコメントの方で、Rustではコメントに従って簡単にドキュメントを生成してくれる仕組みがあるようです。

ドキュメント用のコメントは以下の２つです