code-documentation

    7熱度

    1回答

    我一直在尋找這一段時間,要麼我沒有使用正確的搜索條件,或者我失去了一些東西。 我想弄清楚是否可以使用PHPdoc來定義對象返回的變量。 說我有下面的類:現在 class SomeClass { public function staffDetails($id){ $object = new stdClass(); $object->type = "person"

    1熱度

    2回答

    比方說,一類原始文件看起來是這樣的: /** * My custom class * * This class helps you do stuff. It's really great. * * @author David Smith * @version 1.0 */ 如果我和你一起和返工的代碼的50%,我怎麼記錄,我提出顯著的貢獻? 什麼是添加日期的最佳方式?例如代碼最後修

    0熱度

    1回答

    我越來越堅持記錄我的所有代碼,向我的團隊中的用戶和其他工程師展示我在哪裏找到給定的信息,或者我在哪裏找到特定的代碼段。 我希望能夠完成的是創建與我的代碼(Verilog/SystemVerilog,VHDL,C/C++和RTL源代碼)的行或文件的鏈接,但真的找到或提出瞭解決方案用任何語言都會對我有益。 這將通過Word文檔來完成,PDF文件,我不介意的設置,使用乳膠等,但我想找到這樣的一種方式。基

    5熱度

    4回答

    提前道歉,這是我真正想到的,我可以在網上找到的東西,但我遇到了麻煩。 在Python中,在標題部分,我發現有時候人們會用美元符號($)來包裝它們的文字。從例子來看,這似乎是一個填充信息的指針(可能通過源代碼控制?),但我不明白它是如何工作的。 例如: __version__ = '$Revision: 4799 $'.split()[1] __date__ = '$Date: 2006-09-2

    10熱度

    3回答

    我正在爲瀏覽器應用程序工作的項目編寫我自己的庫,並且我有同樣的老問題來決定如何評論代碼。 我試圖按照JsDoc的語法,但可能會繼續Google Closure Compiler的方式。我可能最終會在文檔中使用兩個@return和@returns標籤,僅僅爲了便於攜帶(當我設置文檔的自動生成時)。 現在,問題你如何記錄自定義匿名對象從函數返回?例如: return { username:

    2熱度

    1回答

    我目前正在爲Google Apps腳本開發一個庫,該庫基本上將電子表格作爲數據庫對象處理。 目前,庫有兩個相同的功能,如 /** * Opens and creates a query object for a spreadsheet with the given url. * * @param {String} the url of the spreadsheet * @return

    8熱度

    3回答

    我對我的問題的簡單道歉,但我嘗試使用Appledocs(https://github.com/tomaz/appledoc#quick-install) 生成文檔我不知道究竟是如何得到它的設置。我這樣做的方式是: 我克隆GitHub庫,然後使用在終端安裝腳本(我確認這使用appledocs --help)安裝appledocs。 我怎麼產生 是它產生在文檔文件: 不過,現在我怎麼居然在我有我的項目

    1熱度

    1回答

    一個FIM ++程序的結構需要,它以一個字母以特定的方式關閉和代碼作者的名字結束。 Dear Princess Celestia and Stack Exchange and String: A Sample: ... Your faithful student, Southpaw Hare! 按照language specification,關鍵字「您忠實的學生」(包括逗號而不是

    4熱度

    3回答

    我開始使用ColdFusion的一個相當大的新項目。這個新項目將包括幾個開發人員,並且這樣的代碼文檔將是關鍵。 我希望避免的另一個問題(無論是有足夠的代碼文檔還是其他工具)都是代碼的重複。能夠「索引」搜索或圖表代碼的工具在這裏可能會有所幫助。 什麼是其他人在那裏使用專門爲ColdFusion或語言不可知的。如果這有所作爲,我們可能會將ColdBox用於底層框架。 感謝您的任何建議。 -c

    1熱度

    2回答

    據我瞭解,「javadoc」是生成html文檔的工具的名稱,該文檔也以名稱javadoc命名。至少我是如何使用這些詞的。 但是,doxygen工具的生成輸出稱爲什麼? Doxygen的-doc的?強力黴素-doc的?或者別的什麼? (問題在C++上下文中,如果它的事項)