documentation

3熱度

1回答

我正在嘗試爲PHP網站創建UML文檔。是的，我知道這不是通常的方式 - 但這個網站已經在生產，現在我們需要UML文檔:) 程序員，使這個網站根本不是OOP - 他沒有使用任何PHP類來創建這個網站。相反，他做了很多PHP文件。我相信PHP世界是相當流行的方法。現在我想知道如何創建此代碼的類圖？正如我所知，類圖只是展示系統架構和編程概念的一種方式。我相信在這種情況下，我可以將單個php文件作爲

2熱度

1回答

AngularJS文檔 - 它們是如何生成的？

AngularJS documentation清晰易讀 - 它是如何生成的？如果使用JSDoc，樣式表是否可用？

0熱度

1回答

是否有任何包可讓您記錄gruntfile，類似於apiDocs for Node？

我有一個很棒的項目，裏面有大量的咕嚕任務。問題是，它膨脹。僅有gruntfile.js就有1200多行。我想通過代碼apiDocs這樣的代碼來記錄我安裝的所有這些grunt插件。那裏是否有任何軟件包可以做到這一點？或者，有沒有一種不同的方式來記錄你的grunt文件？

0熱度

1回答

如何生成constrain.js和kimbo.js文檔？

我遇到文檔的兩個例子，我想嘗試和實施： http://kimbojs.com/api http://cjs.from.so/api 的kimbo源代碼似乎有CSS引用cjs，所以我想也許它是由cjs生成的，但我看不到連接。的cjs回購也有docco.css和dox.js引用，其本身似乎關係到不同的文件解決方案： https://jashkenas.github.io/docco https://

0熱度

1回答

頭文件中的靜態類方法聲明C++

我有一個靜態類，它有幾個函數調用的方法。因爲我不能將它們作爲私有函數添加到頭文件中，而且我不希望它們在類之外被看到，所以我在cpp文件中對它們進行了編碼。我的問題是，因爲我必須編寫項目的文檔，無論如何，我可以將這些函數添加到標題中嗎？（如果不是編碼解釋，我不喜歡在cpp中編寫文檔）。例如： MyStaticClass.h class MyStaticCLass{ public: /**

1熱度

2回答

PHP是否有用於描述無極功能的docblock返回

我只是寫這樣的函數 /** * Send an asynchronous GET request * * @param string $url * @param array $options * * @return \React\Promise\ExtendedPromiseInterface */ public fu

1熱度

1回答

如何在Doxygen中嵌入註釋和可編譯的源代碼/例子？

我想在我的軟件中有一個可編輯的例子，它有註釋，所以它可以包含在Doxygen .dox中。這裏的關鍵部分是我希望註釋成爲源代碼的一部分（這應該是Doxygen的重點，但它似乎缺少這個簡單的功能）那麼，是否有可能將它包含在這種方式看起來像是文本和代碼的混合體，很像\dontinclude示例here？ \snippet -s似乎沒有用，因爲它們需要將註釋與代碼分開。 \dontinclude也是如

0熱度

1回答

IPython等價於Clojure find-doc？

在Clojure repl中，當忘記確切的函數名稱時，我可以使用find-doc來列出其文檔或名稱包含我正在查找的名稱的所有函數。例如： user=> (xor 1 2) CompilerException java.lang.RuntimeException: Unable to resolve symbol: xor in this context, compiling:(/tmp/form

1熱度

1回答

如何在ScalaDoc文檔（版本2.10.6）中引用類型化的類

對不起，如果這是一個愚蠢的問題，但我只是堅持如何最好地記錄此類型的類。我最近開始在Scala工作，並且正在清理一些代碼並添加文檔。我在我的項目中有一個API，它向其他服務的API發出請求，並將該服務的API響應轉換爲我項目API的未來結果。結構示例： object RequestClient { def Request(method: String, path: String, q

0熱度

1回答

使用Sandcastle文檔創建單個HTML /降價文件

簡單問題在這裏。我正在使用Sandcastle Help File Builder以Markdown或HTML格式生成C＃項目的文檔。我的問題是它爲每個記錄的項目創建一個單獨的.md/.html文件。有什麼辦法強制它生成一個包含所有類似於Visual Studio輸出一個XML文件的文檔的大文件，或者至少使用一個目錄系統來至少將輸出結構更好一些，而不是使用一個文件夾~200降價/ html文件。