2012-01-12 22 views
15

有什麼樣的JavaDoc爲Javascript?當我按下Ctrl +空格鍵在NetBeans IDE而的Javascript文件

編寫JavaScript,JavaScript的文檔出來用於指定的對象。但是這個文檔是我猜Netbeans的財產。

如果我們寫不出像樣評價方式的JavaScript,Netbeans的建立文檔我們的自定義JavaScript了。

我們能找到任何這樣的JavaScript文件,Netbeans的外面?那我們可以參考一下嗎?

感謝您的回答。

回答

11

看一看Mozilla的開發人員網絡(MDN)的文檔頁面的靜態參考:

但是,恐怕沒有標籤可以在IDE中使用的完整功能。

+0

正是我需要的。 – Acn 2012-01-12 06:52:25

+9

谷歌搜索提示:添加「MDN」一個javascript期滿後,如,「SUBSTR MDN」和相應的MDN頁面幾乎總是第一個搜索結果。 – nnnnnn 2012-01-12 06:55:51

+1

我不會放棄IDE中的JsDoc(Javadocish)的標籤完成。 WebStorm說,他們支持:http://stackoverflow.com/questions/11076572/seeking-example-of-how-to-use-jsdoc-with-the-webstorm-ide-v-4 – SimplGy 2012-09-07 14:24:37

8

在他們的首頁塗鴉的谷歌的源代碼,他們使用的評論看起來非常相似,javadoc註釋,所以必須有一定的標準,至少谷歌使用。

下面是一個例子:

/** 
* Configuration for a simulator speed setting. 
* - stepTime: ms between simulation steps that do something. 
* - emptyStepTime: ms between no-op steps. 
* - tapeTime: ms for a tape operation. 
* - branchTime: ms for a branch operation. 
* @typedef {{stepTime: number, tapeTime: number, emptyStepTime: number, 
*   branchTime: number}} 
* @private 
*/ 
+2

這是[JSDoc]( http://en.wikipedia.org/wiki/JSDoc)標籤,在本例中爲[Google Closure編譯器](https://developers.google.com/closure/compiler/docs/js-for-compiler),所以它們實際上可以用於功能目的(我認爲編譯器實際上會強制執行它們,例如粘貼示例中的@ typedef和@ private標籤)。 – Ricket 2012-11-25 04:33:56

0

嘗試稱爲奧特里斯的應用程序。它使用某種類似javadoc的語法來生成文檔。 ortelius.marten.dk