// コメントです。
// コメントです。
// コメントです。

/*
コメントです。
コメントです。
コメントです。
*/

let n = 1;  // こういう感じでお尻にコメントを付けます。

// これは私のif文です。
// だれもいじらないでください。
if n < 2 {
    println!("under of two");
}

/* ここの処理はとてもエレガントだ。
   私の知的好奇心を満足させる。
   だが私は不満足だ。満たされない。 */
let n = 1 * 2 * 3;

$ cargo doc

$ cargo doc --open

/// # main
///
/// main関数からプログラムは始まります。  
/// main関数は人気者の関数で一般的です。  
///
/// ## 人気者になりたいですか？
///
/// もしあなたが人気者になりたいのなら行儀の良い関数を定義する必要があります。  
/// 行儀の良い関数は使いやすく人気があります。  
///
fn main() {
    let result = my_func(2).unwrap();
    println!("{}", result)
}

/// # my_func
///
/// my_funcは単純な関数です。  
/// 引数のnの値を2倍にして返します。  
/// nが0より下ならエラーを返します。  
///
/// # Examples
///
/// ```
/// let result = my_func(2).unwrap();
/// assert_eq!(result, 4);
/// ```
///
fn my_func(n: i32) -> Result<i32, &'static str> {
    // nが0より下なら
    if n < 0 {
        Err("invalid number")  // エラーを発生させる
    } else {
        Ok(n * 2)  /* これもコメント */
    }
}

//! # これはビックリマークです
//! 
//! ビックリマークの付いているコメントはどのような機能があるでしょうか？  
//! ここではそれを実際に試してみたいと思います。  
//! どうやらクレートのルートに文書が配置されるようです。
//!

mod my_module {
    //! このモジュールは私のモジュールです。  
    //! 開発中のためだれも使わないでください。  

    /// # func_1
    /// 
    /// この関数は1を返します。
    /// 
    fn func_1() -> i32 {
        1
    }

    /// # func_2
    /// 
    /// この関数は2を返します。
    /// 
    fn func_2() -> i32 {
        2
    }
}

$ cargo test

$ cargo new doc_lib --lib

/// # ドキュメントコードの実行テストです
///
/// このライブラリは  
/// $ cargo new doc_lib --lib  
/// で作成されました。  
///
/// ```
/// use doc_lib::get_one;
///
/// let result = get_one();
/// assert_eq!(result, 1);
/// ```
pub fn get_one() -> i32 {
    1
}

$ cargo test
    Finished test [unoptimized + debuginfo] target(s) in 0.01s
     Running unittests (target\debug\deps\doc_lib-a07aa687dcd56e27.exe)

running 0 tests

test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

   Doc-tests doc_lib

running 1 test
test src\lib.rs - get_one (line 7) ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.27s