rustdoc

    2熱度

    2回答

    我發現rustdoc命令,我有點期待它像pydoc一樣工作。不幸的是,rustdoc std::io:stdin沒有做到我想要的。有沒有辦法通過命令行或某種內置的Web服務器以離線的形式查看標準庫文檔,就像Python的pydoc允許的那樣?

    2熱度

    1回答

    我最近在crates.io上發佈了我的第一個箱子,我想知道是否可以更簡單地維護其文檔。 不少箱子的文檔託管在GitHub頁面上,所以我想我會給它一個鏡頭。我創建了一個user.github.io回購,生成了文檔cargo doc,並將它們推送給它。一切正常,文件可以從crates.io查看。 但是,更新它們是不方便的;如果我修改箱子的文檔,我需要: 推動這些變化在包裝箱的回購 產生通過cargo

    3熱度

    1回答

    我注意到編譯插件經常提供文檔甚至不提及的宏。它們以編程方式註冊和創建,而不是在rustdoc識別的語法中定義。當然,沒有文檔可以顯示。 我正在尋找一種方法來解決這個問題,一些生成文檔的方法在編譯時並不存在於箱子中。 我注意到語法箱子也可以從這樣的事情中受益。例如,quote_item完全沒有記錄。我甚至找不到註冊它的代碼。

    2熱度

    1回答

    Markdown應該如何與rustdoc一起使用以包含圖表或ASCII藝術? 通過閱讀手冊,可以使用三重反撥號代碼段。 如何包含文字,非格式文本? (如Doxygen's<pre>...</pre>東西)

    2熱度

    1回答

    有一個偉大的工具rustdoc(cargo目前使用)到test examples of documentation comments in Rust。在Ruby中,rdoc或者yard是否給了我們類似的東西?

    4熱度

    2回答

    我正在嘗試爲我在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

    9熱度

    2回答

    rustdoc允許您通過包括每個行之前的文檔註釋記錄結構域和枚舉變量: enum Choices { /// The first choice. First, /// The second choice. Second, } struct Person { /// The person's name. name: String,

    2熱度

    1回答

    是否可以對API的各個部分進行分組?例如相關的功能,類型或常數。 的Doxygen例如支持grouping like this: /** \name Some API Grouping * \{ */ // code // /* \} */ 是rustdoc能夠類似的東西?

    2熱度

    2回答

    在編寫Rust文檔測試時,是否有可能將部分代碼外部化爲外部文件以縮短示例?