6

我正在尝试为我正在用 Rust 编写的项目编写文档。其中一个文档需要使用regex::Regex. 这是我正在尝试编写的文档:

/// Return a list of the offsets of the tokens in `s`, as a sequence of `(start, end)`
/// tuples, by splitting the string at each successive match of `regex`.
///
/// # Examples
///
/// ```
/// use rusty_nltk::tokenize::util::regexp_span_tokenize;
/// use regex::Regex;
///
/// let s = "Good muffins cost $3.88\nin New York.  Please buy me
///         two of them.\n\nThanks.";
/// let regex = regex::Regex::new(r"\s").unwrap();
/// let spans = regexp_span_tokenize(s, regex).unwrap();
/// ```

它给了我这个错误:

---- tokenize::util::regexp_span_tokenize_0 stdout ----
    <anon>:4:9: 4:14 error: unresolved import `regex::Regex`. Maybe a missing `extern crate regex`? [E0432]
<anon>:4     use regex::Regex;
                 ^~~~~
error: aborting due to previous error

但是当我添加时extern crate regex;,我得到了这个错误:

---- tokenize::util::regexp_span_tokenize_0 stdout ----
    <anon>:3:9: 3:19 error: unresolved import `rusty_nltk::tokenize::util::regexp_span_tokenize`. Maybe a missing `extern crate rusty_nltk`? [E0432]
<anon>:3     use rusty_nltk::tokenize::util::regexp_span_tokenize;
                 ^~~~~~~~~~
<anon>:4:9: 4:14 error: unresolved import `regex::Regex`. Did you mean `self::regex`? [E0432]
<anon>:4     use regex::Regex;
                 ^~~~~
error: aborting due to 2 previous errors

相关文件的一些相关部分是:

src/lib.rs:

extern crate regex;
pub mod tokenize;

src/tokenize/mod.rs:

extern crate regex;
pub mod util;

(顶部)src/tokenize/util.rs:

extern crate regex; 
use regex::Regex;

我的项目布局做错了什么?

4

2 回答 2

9

来自The Rust Programming Language,第一版文档章节:

这是 rustdoc 用于预处理示例的完整算法:

  1. 任何前导#![foo]属性都保留为 crate 属性。
  2. 插入了一些常见的允许属性,包括unused_variablesunused_assignmentsunused_mutunused_attributesdead_code。小例子经常触发这些 lint。
  3. 如果示例不包含extern crate,则extern crate <mycrate>;插入。
  4. 最后,如果示例不包含fn main,则将文本的其余部分包裹在fn main() { your_code }

第 3 点在这里是相关的。当你没有 extern crate行时,你的箱子会自动添加。一旦你添加了第一个extern crate,将不会自动添加任何 crate——包括你的 crate!

您将需要为和添加extern crate行。regexrusty_nltk

于 2015-12-19T18:46:34.787 回答
4

在被指向文档后,我通过用s包裹main我的代码来解决它:extern crate

/// Return a list of the offsets of the tokens in `s`, as a sequence of `(start, end)`
/// tuples, by splitting the string at each successive match of `regex`.
///
/// # Examples
///
/// To return a list of spans based on whitespaces:
///
/// ```
/// extern crate regex;
/// extern crate rusty_nltk;
/// use rusty_nltk::tokenize::util::regexp_span_tokenize;
/// use regex::Regex;
///
/// fn main() {
///   let s = "Good muffins cost $3.88\nin New York.  Please buy me
///           two of them.\n\nThanks.";
///   let regex = Regex::new(r"\s").unwrap();
///   let spans = regexp_span_tokenize(s, &regex);
/// }
/// ```

我决定更改我的文档样式以包含main所有示例的 s,但如果这不是您的样式,您可以#在代码之前添加以将其隐藏在文档中。

于 2015-12-19T18:50:01.537 回答