JavaScript域

在 1.0 版本加入.

JavaScript域（名称 js）提供以下指令：

.. js:module:: name

该指令设置后面的对象声明的模块名称。 模块名称用于全局模块索引和交叉引用中。 该指令不会创建如下的对象标题 py:class。

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

在 1.6 版本加入.

在 5.2 版本发生变更: 模块指令支持正文内容。

.. js:function:: name(signature)

描述JavaScript函数或方法。如果要将参数描述为可选，请使用方括号 documented 用于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: (no value)

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

在 7.1 版本加入.

.. js:method:: name(signature)

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

在 1.6 版本加入.

:single-line-parameter-list: (no value)

确保函数的参数将在单个逻辑行上发出，覆盖 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: (no value)

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

在 7.1 版本加入.

.. js:data:: name

描述全局变量或常量。

.. js:attribute:: object.name

描述 物体 属性 名称。

提供这些角色是为了引用所描述的对象：

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