documentation

    0熱度

    1回答

    我正在編寫尚未完全寫入的winForms項目,這意味着有另一位程序員正在編寫代碼。所以我已經在項目的副本中寫了一些重要的評論。 另外我使用sandcastle來建立幫助文件。 我的問題:將項目舊副本中的評論複製到新版本的最佳方法是什麼(如果有的話)? 也許sandcastle可以做一些將文檔導入項目的工作? 我知道這樣做並不那麼聰明,但我仍然需要檢查是否有辦法保存文檔的工作。

    2熱度

    1回答

    我一直在試圖將Apple的變體Markdown文檔添加到我編寫的所有函數中。但是,我不確定如何添加此文檔以在quicklook窗口中顯示。是否有可能替換或理想地附加到現有文檔? 例如,在此圖片中,quicklook窗口顯示現有的Markdown文檔,而不是我上面編寫的文檔。

    2熱度

    1回答

    我正在研究面向對象的Matlab應用程序,並且想知道如何添加像Matlab自己的函數和類一樣具有全面的幫助頁面。我特別感興趣的是將乳膠添加到幫助頁面。作爲一個例子,我添加了一張關於我的幫助頁面的外觀以及我希望看起來像他們的圖片。

    3熱度

    1回答

    (注:這是被要求分享知識,而不是尋求幫助) click是與發展中國家CLI應用的流行Python庫。 sphinx是用於記錄Python包的流行庫。 One problem that some have faced正在整合這兩個工具,以便他們可以生成基於點擊命令的Sphinx文檔。 我最近遇到這個問題。我用click.command和click.group修飾了我的一些函數,爲它們添加了文檔,然後

    2熱度

    1回答

    直列jsdoc我知道如何爲嵌入式類型參數: function foo(/**number*/theNum, /**string*/theText){} 但是我怎麼形容使用此方法的返回類型? 我不是在談論這樣做上面的函數,這樣的方式: /** this method takes too much space! * @returns {boolean} */ function foo(){

    4熱度

    1回答

    Python標準庫中是否有一個模塊在PEP 8和PEP 257之後做得很好?我經常發現自己將Python模塊或類放在一起,通過上述PEP來確保我正確地執行了我的文檔。 我想看到的是一個可以在任何Python安裝中使用的文件,並作爲正確的模塊,類,函數,變量和(特別是!)docstring樣式的示例,包括關鍵字參數文檔。

    -1熱度

    1回答

    我有一個包含很多源代碼的項目。出於文檔目的,我必須將所有源代碼合併到一個文件中,例如PDF,HTML或DOCX。優選地,每個合併的文件內容應該具有與其相對來源的標題。不錯的格式是需要的,但不是強制性的。 有沒有人做過這個任務?有沒有簡單的代碼片段來自動執行任務?奇怪的是,我四處搜尋,沒有發現任何關於這個挑戰的提示。

    1熱度

    2回答

    我目前已經寫了一個腳本,產生幾個數字。我想知道是否有辦法將這些數字直接發佈到tex文件中,比如說eps格式,而不包括所有的python代碼。我也想包括一些變量的值。我查看了模塊pweave(http://mpastell.com/pweave/),但我找不到排除代碼塊的方法。我是新來的python,所以任何幫助將不勝感激!

    1熱度

    1回答

    我的理解是: conf.verb = 0 禁用Scapy的詳細模式,但其中的文件,以證實這一點? 我的谷歌搜索失敗了我。

    2熱度

    1回答

    我在RStudio & devtools的幫助下爲命名空間做了一個軟件包,對於手冊頁描述爲& Roxygen2。這工作得很好,我最近添加的幫助頁也起作用了。我決定添加作者姓名,電子郵件和一些細節。最初由手動編輯手冊頁文件(BAD),然後編輯將R腳本Roxygen2部分&推動改變對RM文件,document() 但是:當我安裝我的包 devtools::install_github('SimonDe