JavaScript 域

版本 1.0 新增。

JavaScript 域 (名称为 js) 提供了以下指令

.. js:module:: name

此指令设置后续对象声明的模块名称。模块名称用于全局模块索引和交叉引用。此指令不会像 py:class 那样创建对象标题。

默认情况下，此指令将创建一个可链接的实体，并在全局模块索引中生成一个条目，除非指定了 no-index 选项。如果指定了此选项，则该指令将仅更新当前模块名称。

版本 1.6 中新增。

5.2 版更改: 模块指令支持正文内容。

.. js:function:: name(signature)

描述 JavaScript 函数或方法。如果要将参数描述为可选，请使用方括号，如 Python 签名文档中所述。

您可以使用字段来提供有关参数及其预期类型、函数可能引发的错误以及返回值等更多详细信息

.. js:function:: $.getJSON(href, callback[, errback])

   :param string href: An URI to the location of the resource.
   :param callback: Gets called with the object.
   :param errback:
       Gets called in case the request fails. And a lot of other
       text so we need multiple lines.
   :throws SomeError: For whatever reason in that case.
   :returns: Something.

这呈现为

$.getJSON(href, callback[, errback])
参数:

  • href (string) – 资源的 URI 位置。

  • callback – 使用对象调用。

  • errback – 如果请求失败，则调用。还有许多其他文本，因此我们需要多行。

抛出:

SomeError – 在那种情况下，无论什么原因。

返回:

某物。

:single-line-parameter-list: (无 值)

确保函数的参数将以单个逻辑行发出，覆盖 javascript_maximum_signature_line_length 和 maximum_signature_line_length。

版本 7.1 新增。

.. js:method:: name(signature)

此指令是 js:function 的别名，但它描述了一个作为类对象上的方法实现的函数。

版本 1.6 中新增。

:single-line-parameter-list: (无 值)

确保函数的参数将以单个逻辑行发出，覆盖 javascript_maximum_signature_line_length 和 maximum_signature_line_length。

版本 7.1 新增。

.. js:class:: name

描述一个创建对象的构造函数。这基本上就像一个函数，但会显示一个 class 前缀

.. js:class:: MyAnimal(name[, age])

   :param string name: The name of the animal
   :param number age: an optional age for the animal

这呈现为

class MyAnimal(name[, age])
参数:

  • name (string) – 动物的名称

  • age (number) – 动物的可选年龄

:single-line-parameter-list: (无 值)

确保函数的参数将以单个逻辑行发出，覆盖 javascript_maximum_signature_line_length 和 maximum_signature_line_length。

版本 7.1 新增。

.. js:data:: name

描述一个全局变量或常量。

.. js:attribute:: object.name

描述 object 的属性 name。

提供了这些角色来引用所描述的对象

:js:mod:
:js:func:
:js:meth:
:js:class:
:js:data:
:js:attr: