Visual Studio-JavaScript注釋寫法

來源:互聯網
上載者:User

用過Visual Studio的人應該對它的代碼智能提示很熟悉了吧?

可是,如果您是一位Web開發人員可能就感覺不那麼爽了。

因為Visual Studio對代碼的提示太有限了!


不過,最近如果您關注jQuery的話,應該已經知道Visual Studio已經可以對jQuery進行比較詳細的提示了!這是怎麼做到的呢?其實很簡單,而且我們也可以很快上手。


先來一段WebGL的代碼提示(最新的Visual Studio2013都沒有內建此提示哦!也就是說這個提示是我自己寫的。如有需要請留郵箱)



是否感覺到十分的方便?參數類型、函數用法提示,每個參數含義提示。。。。

爽爆了!


下面我們就來講講在一般開發中如何讓Visual Studio彈出我們的自訂提示吧!範例程式碼:

function getUsername (user) {    /// <summary>擷取使用者名稱稱</summary>    /// <param name="user" type="Object">使用者物件</param>    /// <returns type="String">使用者名稱稱</returns>}
下面是結果預覽:


可以看到,正確的彈出了我們想要的函數作用提示、參數作用及類型提示、返回值類型提示。

如果我們有函數重載該如何呢?

function getUsername(user,sex) {    /// <signature>    ///     <summary>擷取使用者名稱稱</summary>    ///     <param name="user" type="Object">使用者物件</param>    ///     <returns type="String">使用者名稱稱</returns>    /// </signature>    /// <signature>    ///     <summary>擷取使用者名稱稱</summary>    ///     <param name="user" type="Object">使用者物件</param>    ///     <param name="sex" type="Boolean">使用者性別</param>    ///     <returns type="String">使用者名稱稱</returns>    /// </signature>}
下面是結果預覽:


是不是非常簡單?其實上面這些函數完全不必要寫參數,即只需要這樣就可以了 function getUsername(){//.....}因為Visual Studio會把我們寫的注釋解析成參數對象,所以一樣可以提示的喲!


那麼我們來看看另外的一些用法。


對象屬性:

/// <field name="age" type="Number">年齡</field>
預覽:




至此就結束了,大家可以參考這裡做一些更多的內容:http://msdn.microsoft.com/zh-cn/expression/hh524453


有更多要討論的請留鹽吧!

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.