2015-09-02 26 views
0

我正在運行VS2013,我剛開始使用TypeScript。如何存根TypeScript函數註釋?

我安裝了Web Essentials 2013.5和DocStubJs。目前,當我正在編寫javascript時,我使用由DocStubJs自動創建的C#-ish功能註釋: enter image description here

我這樣做主要是因爲DocStubJs爲我省略了評論。它(我假設它是DocStubJS這樣做的)甚至可以在TypeScript中工作,並且我剛開始使用它,因爲它很熟悉,並且是大多數代碼的反正。但在更多的文件找打字稿後,我看到他們使用的JsDoc格式:

/** 
    * Does stuff 
    * 
    * @param blah stuff needing done 
    */ 
    public doStuff(blah: string) {} 

我應該使用哪種格式,在XML上下的註釋,或DocJs?如果我進入DocJs路線,是否有無法自動地將評論存檔?

回答

0

更新2015/9/25:更好的JsDoc腳手架被添加到今天的TypeScript主模塊中https://github.com/Microsoft/TypeScript/pull/4978。如果您覺得冒險,歡迎您克隆回購,enable VS dev mode,並在今天使用。 :)

去與JsDoc路線。 TypeScript團隊正在爲即將發佈的版本添加對JsDoc的支持,其中包括類型信息,intellisense和腳手架。與TS 1.6 beta,腳手架現在與function s一起使用。未來可能會增加更多的支持。

+0

太糟糕了,現在不得不手動滾動它。注意到Xml版本不支持方法重載 – Daryl

0

使用JsDocs因爲XML註釋與智能感知方法打字稿

超載也只是想通了,打字/**將存根爲你的JsDoc註釋不起作用。