如何:创建 JavaScript XML 文档注释
Visual Studio 2012
如何:创建 JavaScript XML 文档注释

XML 文档注释是 JavaScript 注释添加到脚本提供有关代码元素 (如函数、 字段和变量的信息。 在 Visual Studio,这些文本说明显示与 IntelliSense 时,引用的脚本函数。

本主题提供基本教程,说明如何使用 XML 文档注释。 有关使用其他元素,如 <var> (JavaScript)<value> (JavaScript),和其他代码示例,请参阅 XML 文档注释 (JavaScript)。 有关提供 IntelliSense 的异步回调的信息,如Promise,请参阅 <returns> (JavaScript)

说明

只能从引用的文件、 程序集和服务可用 XML 文档注释。

若要创建 XML 文档注释的 JavaScript 函数

  • 在函数中,添加 <summary> (JavaScript)<param> (JavaScript),和 <returns> (JavaScript)元素,并在前面三个斜杠 (/ /) 与每个元素。

    说明

    每个元素必须全部在一行上。

    下面的示例演示一个 JavaScript 函数。

    1. function getArea(radius)
    2. {
    3. /// <summary>Determines the area of a circle that has the specified radius parameter.</summary>
    4. /// <param name="radius" type="Number">The radius of the circle.</param>
    5. /// <returns type="Number">The area.</returns>
    6. var areaVal;
    7. areaVal = Math.PI * radius * radius;
    8. return areaVal;
    9. }
  • 要查看 XML 文档注释,请键入名称和左括号的函数,如下例所示的 XML 文档注释标记:

    1. var areaVal = getArea(

    在键入左括号的函数包含 XML 文档注释的时,代码编辑器中使用 IntelliSense 显示 XML 文档注释中定义的信息。

若要创建 JavaScript 字段的 XML 文档注释

  • 在构造函数的函数或对象定义中添加 <field> (JavaScript)元素前面三个斜杠 (/ /)。

    下面的示例显示如何使用<field>构造函数中的元素。 有关其他示例,请参见 <field> (JavaScript)

    1. function Engine() {
    2. /// <field name='HorsePower' type='Number'>The engine's horsepower.</field>
    3. this.HorsePower = 150;
    4. }
  • 若要查看 XML 文档注释,请通过使用 XML 文档注释,如下例所示使用函数构造函数标记为创建对象。

    1. var eng = new Engine();
  • 在下一行中,键入该对象,以显示该字段的 IntelliSense 信息段的名称。

    1. eng.

若要创建 XML 文档注释的重载函数

  1. 在函数中,添加 <signature> (JavaScript)元素,为每个重载。 在这些元素中,添加其他元素,如<summary>, <param>,和<returns>前三个斜杠 (/ /) 与每个元素。

    下面的示例演示重载的 JavaScript 函数。 在此示例中,参数类型不同的重载。

    1. function calc(a) {
    2. /// <signature>
    3. /// <summary>Function summary 1.</summary>
    4. /// <param name="a" type="Number">A number.</param>
    5. /// <returns type="Number" />
    6. /// </signature>
    7. /// <signature>
    8. /// <summary>Function summary 2.</summary>
    9. /// <param name="a" type="String">A string.</param>
    10. /// <returns type="Number" />
    11. /// </signature>
    12. return a;
    13. }
  2. 要查看 XML 文档注释,请键入名称和左括号的函数的使用,如下例所示的 XML 文档注释标记:

    1. calc(

若要创建本地化的 IntelliSense

  1. 创建具有 OpenAjax MessageBundle 格式的文档注释的 XML 文件。

    重要事项

    MessageBundle 是推荐的格式。 在 Microsoft Ajax 或.winmd 文件中不支持此格式。 有关使用另一种VSDoc设置的格式,请参阅 <loc> (JavaScript)

    下面的示例中包含本地化的 IntelliSense 信息的附属文件的显示内容。 这是一个 XML 文件,它位于一个特定于区域性的文件夹,如 JA。 该文件夹必须为.js 文件所在的相同位置中<loc>元素。 XML 文件的文件名必须与匹配filename参数中指定<loc>元素。

    <messagebundle>
    <msg name="1">A class that represents a rectangle</msg>
    <msg name="2">The length of the rectangle</msg>
    <msg name="3">The height of the rectangle</msg>
    </messagebundle>
  2. 在.js 文件中,添加以下代码。 <loc>元素,必须声明之前的任何脚本,并遵循相同的用法规则<reference>元素。 有关更多信息,请参见 JavaScript IntelliSense<loc> (JavaScript)

    1. /// <loc filename="messageFilename.xml" format="messagebundle"/>
  3. 在.js 文件中,添加的 XML 文档的元素和默认说明。 设置locid属性值,以匹配相应的name从附属文件属性值。 如果可用本地化的 IntelliSense 信息将被替换的默认说明。

    1. function add(a,b)
    2. {
    3. /// <summary locid='1'>description</summary>
    4. /// <param name='a' locid='2'>parameter a description</param>
    5. /// <param name='b' locid='3'>parameter b description</param>
    6. }
  4. 要查看 XML 文档注释,请键入名称和左括号的函数,如下例所示:

    1. add(

转 创建 JavaScript XML 文档注释的更多相关文章

  1. C# XML 文档注释文件格式

    在编写 C# 代码时,只要在注释按照格式加入 XML 文档注释,例如: /// <summary> /// 这里是类的注释. /// </summary> public cla ...

  2. 编写Java程序,使用 dom4j 创建一个 XML 文档,文档名为“city.xml”。注意该文档的格式和数据

    查看本章节 查看作业目录 需求说明: 使用 dom4j 创建一个 XML 文档,文档名为"city.xml".该文档的格式和数据如图所示 实现思路: 创建Java项目,添加dom4 ...

  3. 编写Java程序,创建一个 XML 文档,文档名为“hero.xml”,用于保存“王者荣耀”的英雄信息。

    查看本章节 查看作业目录 需求说明: 创建一个 XML 文档,文档名为"hero.xml",用于保存"王者荣耀"的英雄信息.英雄信息包括编号(id).姓名(na ...

  4. C# XML 文档注释

    原文链接:http://www.shinater.com/DocsBuilder/help.html <summary>description</summary> 描述类型或类 ...

  5. C#中XML文档注释编译DLL引用到其它项目

    引用地址:http://zhidao.baidu.com/link?url=jSGYEBysE4gBExtNsHCVk3vd2OK2cMlaf02cS79GdRuGueTBdFJB0btOdBYkg_ ...

  6. C#中的XML文档注释-推荐的文档注释标记

    文档注释是为了方便自己和他人更好地理解代码所实现的功能.下面记录了一些常用的文档注释标记: <C> 用法: <c>text</c> 将说明中的文本标记为代码.例如: ...

  7. Java四种读取和创建XML文档的例子教程

    四种方法解析XML文档:Dom.SAX.JDOM.dom4j          1.了解XML XML,即可扩展标记语言(Extensible Markup Language),标准通用标记语言的子集 ...

  8. 代码创建xml文档并写入指定节点

    //首先创建 XmlDocument xml文档 XmlDocument xml = new XmlDocument(); //创建根节点 config XmlElement config = xml ...

  9. XML——对XML文档的创建与增删改查

    一.创建的第一种方式  //1.创建一个XML文档 XmlDocument doc = new XmlDocument(); //2.创建第一行描述信息 XmlDeclaration dec = do ...

随机推荐

  1. Memcached启停脚本小结

    编写配置文件 编写启动脚本 vim /etc/rc.d/init.d/memcached startesac and $<!= 0); } elsif (open PIDHANDLE," ...

  2. BZOJ1085 [SCOI2005]骑士精神(IDA*)

    IDA*是IDS的基础上加上满足A*算法的估值函数来剪枝的搜索算法. 这题代码量挺少的,可以看出整个IDA*的框架: #include<cstdio> #include<cstrin ...

  3. 奇妙的旅行[XDU1012]

    Problem 1012 - 奇妙的旅行 Time Limit: 1000MS   Memory Limit: 65536KB   Difficulty: Total Submit: 396  Acc ...

  4. 浅谈Apache Spark的6个发光点(CSDN)

    Spark是一个基于内存计算的开源集群计算系统,目的是更快速的进行数据分析.Spark由加州伯克利大学AMP实验室Matei为主的小团队使用Scala开发开发,其核心部分的代码只有63个Scala文件 ...

  5. BJOI2015 Day2

    轮到罗剑桥出题了 这是什么风格,中文名称与英文名称分明对不上吗233 T1: 似乎只会做这道题23333 A....BE ........ C....DF 据题意数学变形得A-C<=B-D,B- ...

  6. Java读取txt文件

    package com.loongtao.general.crawler.slave.utils; import java.io.BufferedReader; import java.io.File ...

  7. Nhibernate Case SUM

    SELECT ID END) as nbRowWithValueOf2, END) as nbRowWithValueOf3 FROM Foo GROUP BY ID queryover = quer ...

  8. zabbix自定义键值原理

    子配置文件的配置 为了便于维护和分类管理,UserParameter的内容可以单独写一个配置文件 # vim /usr/local/zabbix/etc/zabbix_agentd.conf Incl ...

  9. 微博开发平台java SDK demo学习之examples(demo)

    本文介绍demo中函数的功能分块 账号 评论 收藏 关系/好友分组 地理信息 OAuth2(开发指南) 位置服务(开发指南)

  10. 【iCore2 模块相关资料】发布模块DEMO 代码包,目前支持 iM_TFT30、 iM_LAN和 iM_RGB 三个模块

    iCore2 模块底板 和部分模块发布了,所以我们做了一个 DEMO 代码包,此代码包现在有以下功能: 1.支持 iM_TFT30 3寸触摸液晶模块(硬件已发布): 2.支持 iM_LAN 100M以 ...