vs2010的javascript 智能提示文档书写

vs2010的javascript 智能提示文档书写

 

第一种情况:

js代码:

(function () {

    var codeex = window.codeex = function () {
        /// <summary>
        /// codeex的vs注释测试。
        /// </summary>
    };

    codeex.fun1 = function () {
        /// <summary>
        /// 测试函数1。
        /// </summary>
    }


    codeex.fun2 = function () {
        /// <summary>
        /// 输出HelloWorld。
        /// </summary>
        ///<returns type="String" />
        return "helloworld!";
    }

    codeex.fun3 = function (name) {
        /// <summary>
        /// 输出HelloWorld。
        /// </summary>
        /// <param name="name" type="String">
        ///  1: name - helloworld的对象。
        /// </param>
        ///<returns type="String" />
        return "hellowrold!" + name;
    }
})();

 

说明:所有注释都要写在函数内部，<summary>是函数的描述，<param>是参数的描述,<returns>是返回值的描述,js文件按 xxx-vsdoc.js保存。然后在vs2010里就可以看到智能提示了。

 
第二种情况：
类或函数的自动提示,函数参数和返回值的提示补充:在<script src="... 之类的外部引入的js文件里

可以通过在js文件开始的地方加入

/// <reference path="codeex-vsdoc.js" />

来开启智能提示