文件測試
文件註釋中的程式碼將由 cargo test
自動執行。這些被稱為文件測試,有助於確保你的示例有效並且不會誤導你的箱子使用者。
你可以從包根匯入相對(就好像示例頂部有隱藏的 extern crate mycrate;
)
/// ```
/// use mycrate::foo::Bar;
/// ```
如果你的程式碼可能無法在文件測試中正確執行,則可以使用 no_run
屬性,如下所示:
/// ```no_run
/// use mycrate::NetworkClient;
/// NetworkClient::login("foo", "bar");
/// ```
你還可以指出你的程式碼應該是恐慌,如下所示:
/// ```should_panic
/// unreachable!();
/// ```