documentation-generation

    1熱度

    1回答

    隨着phpDocumentor,你怎麼記錄有這樣的默認值的可選參數歸檔默認值默認值記錄在案?

    7熱度

    1回答

    我有這種方法,我試圖生成文檔。 /// <summary> /// This method demonstrates taking a Func as argument and perform that action(Func) on a list of strings.</summary> /// <param name="listOfStrings"> ... </para

    1熱度

    1回答

    有一些非常類似的問題,但沒有我找到的答案似乎提供了一個文檔生成器,正確支持所有谷歌關閉註釋。 JSDoc無法正常工作(在編寫3.3.0版本時)。 JSDoc確實工作得很好,但不能正確地處理函數類型,如下面的例子: /** * @param {function(string)} cbk A callback taking a string */ var hello = function(cb

    0熱度

    1回答

    我們正處於巨大的SAP安裝過程中。一切工作正常,但我不滿意的顧問/開發人員的文檔方法和stlye。 文檔過於細化,開發人員往往迷失在細節中,鳥瞰圖非常丟失。 有什麼工具可以生成報告/文檔或抓取infotype/events/relations嗎? 是否有任何方法來創建(自動或手動)縮略圖 文檔? 在此先感謝您。

    0熱度

    1回答

    我已經發布了幾個NuGet包(.NET類庫)。這些軟件包包含每個DLL的XML文檔文件。所有軟件包都在www.nuget.org和www.symbolsource.org上發佈。 現在,是否有一個網站/服務會自動生成(和主機)我的軟件包的文檔?我爲我的軟件包描繪了一些小型網站,用戶可以從XML文件中看到所有的類定義,它們的方法和相關文檔(基本上類似於MSDN,但對於我的包)。 理想情況下,每次發佈

    5熱度

    1回答

    爲了記錄,可以採取其接收其值串的矢量陣列的變量: /* * @var string[] An array of string objects. */ $foo = array('A', 'B', 'C'); 爲了記錄,可以採取其接收其值整數的向量陣列的變量: /* * @var int[] An array of string objects. */ $foo = array(1,

    0熱度

    1回答

    目前我有一個在Joomla中製作的網站,其中包含有關3種語言的某些軟件(LogicalDOC)的文檔。 http://help.logicaldoc.com/ 我需要的各個部分轉換成相應的PDF手冊。 因此,應將安裝指南轉換爲PDF格式,以及其他部分:用戶指南,管理員指南和工作流程指南(位於頂部菜單中)。 我想知道是否有一個軟件或不同的方式(插件)將PDF 的網站與導航菜單轉換,並可能使文件以CH

    6熱度

    2回答

    我試圖使用獅身人面像的方式來記錄文檔的多個「級別」,例如: API參考 手冊 教程 等 這個想法是,內容列表顯示在側欄相對於你所在的部分。所以,當你在主索引它o nly顯示了上面提到的部分。當你進入例如。 「手動」它顯示了特定於該部分的不同ToC,以及返回主ToC的方式。 我一直在試圖弄清楚如何在沒有黑客入侵的情況下在Sphinx中工作,但到目前爲止還不能完全弄清楚方式。文件夾結構已經反映了不同的

    6熱度

    2回答

    是否有任何工具讓Typescript自動生成註釋註釋文檔? 我試着用TypeScript的JSDoc。它在一定程度上起作用,但它們並不意味着一起工作。 任何意見/建議?

    1熱度

    1回答

    我有一些模塊級別的變量,我想從自動生成的文檔中排除很長且無趣的值。有沒有辦法做到這一點? 例如,在我的Python源我有類似 #:This is a variable with a log value. long_variable = "Some really long value that is not really of interest and just kind of gets in t