documentation-generation

    -2熱度

    1回答

    爲某些通信或配置文件創建XML時,您可能需要向其他人說明該文件的工作原理。什麼標籤用於什麼。 首先,您將創建XSD,您將在其中定義如何創建和使用XML。還有annotation和documentation標籤可以更好地解釋它。 但是,有沒有工具如何將XSD轉換爲對普通用戶更易讀的文檔?例如在設置od html文件或tex或pdf文件中。 如果它有關係圖像,那會更好,但這不是必須的。

    -1熱度

    1回答

    scikit-learn是一個組織良好的網站,是一種整潔的文檔源代碼方式。網頁是否自動生成?有沒有一個框架產生這些網頁? 學習使用了哪個框架可以幫助我記錄其他類似的存儲庫。

    1熱度

    1回答

    我們在這裏得到了一些像10年前的C和C++代碼,沒有文檔或手冊。然而,頭文件中記錄的源代碼相當不錯,但通過所有查找信息的文件需要很多工作。它看起來像這樣: // Description description .... // // @param parameter 1 name: // description of parameter 1 // // @param parameter 2

    0熱度

    1回答

    在用roxygen2記錄S4類之後,我決定退後一步,使用package.skeleton,promptClass和promptMethod創建最小示例。 我的問題是R CMD check仍然給出了一個關於「無證代碼對象」的警告,但我認爲我已經正確記錄它們。 我現在的文件有: testClass.R: setClass("testClass", slots = c(a = "numeri

    2熱度

    1回答

    我想創建一個打字稿DOC發電機JSON模式,但這樣做,我需要解析打字稿文件到的東西更容易閱讀 EX: "Command": { "description": "A command object for the command handler", "constructor": [ { "name": "name", "type": "strin

    0熱度

    1回答

    運行沿側styleguidist我想記錄我的反應的組分和我一起端運行styleguidist服務器與Laravel開發服務器但styleguidist服務器崩潰,此錯誤。 You have another server running at port 6060 somewhere, shut it down first You can change the port using the `se

    1熱度

    1回答

    如何將獅身人面像生成的乳膠代碼集成到現有的乳膠文檔中? 我的問題與here相同,但我在6年後認爲應該找到解決此問題的方法。如果沒有,現在有一些步驟可以手動進行?最佳實踐?

    0熱度

    1回答

    有兩個責任; 第一個問題 我的項目層次this 和我之前想對每一個項目的代碼文檔爲了這個,我使用docfx。第一個問題是 ; 我不希望構建代碼被重建。 ex。 docfx ./docs/docfx.json --serve -> doing the build 第二個問題; 我想要文檔結果給我其他路徑。 ex。 C:\Users\ahmet\Documentation 代碼 docfx d

    -1熱度

    1回答

    我正在使用Specflow來編寫我的Web自動化測試,並且一切進展順利。 我正在使用配置文件中的目標爲每個瀏覽器運行一次我的功能。 我想使用Pickles來記錄我的功能和測試結果,但它結合了結果並採取了最好的措施。 例如,我有一個測試在Firefox中失敗,但通過Chrome和IE。 當我創建我的Pickles文檔時,它將標記爲已通過的一個測試。 有沒有人知道如何/如果醬菜可以支持多次運行的功能或

    1熱度

    1回答

    我使用組織模式編寫軟件文檔,其中API函數,變量等文檔自動從其中提取代碼的文檔字符串(恰好在Common Lisp中)。然後將該文檔導出爲HTML(我碰巧通過reStructuredText通過ox-rst和Sphinx執行此操作)。它的工作原理很像使用Sphinx直接與Python一起使用,但具有組織模式的所有特性,如可執行代碼塊。 爲了簡要說明原理,我演示了使用Emacs Lisp進行簡化的方