2013-03-19 60 views
16

我最近開始使用jsdoc註釋來記錄我們的javascript代碼,但是我發現了@param標記的用法的衝突示例。什麼是jsDoc評論的正確使用方法?

參見https://code.google.com/p/jsdoc-toolkit/wiki/TagParam(PascalCase)

https://developers.google.com/closure/compiler/docs/js-for-compiler和(駱駝/小寫)。

駝峯對我來說很有意義,因爲:

var foo = 1; 
console.log(typeof foo); // outputs "number" 

什麼是用於jsDoc @param意見正確的外殼?或者沒有關係?我打算將它用於文檔生成以及通過谷歌關閉運行代碼以獲取類型檢查。

謝謝!

回答

16

爲JSDoc型表達的衝突的實施例涉及的JavaScript原始類型stringnumberboolean,其具有相應的包裝類型:StringNumber,和Boolean

Closure: The Definitive Guide來自:

使用包裝類型是禁止在Closure Library,彷彿包裹類型用於 其中原始類型預期 一些功能可能無法正常運行。

查看MDN:Distinction between string primitives and String objects

+3

在大多數情況下,您需要原始類型而不是對象類型。編譯器會在必要時自動對原始類型進行加框(提升),但反過來不是這樣。 – 2013-03-20 15:03:00

+0

謝謝cpeisert!我一定要拿到那本書! – magritte 2013-03-20 19:44:56

+0

絕對要做。這是一個很棒的閱讀,而不僅僅是它的封閉信息! – jordancpaul 2013-04-06 09:06:45

相關問題