JavaScript领域

Added in version 1.0.

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

.. js:module:: name

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

默认情况下，此指令将创建一个收件箱实体并导致全局模块索引中出现条目，除非 no-index 已指定选项。 如果指定此选项，该指令将仅更新当前模块名称。

Added in version 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 .

Added in version 7.1.

.. js:method:: name(signature)

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

Added in version 1.6.

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

确保函数的参数将在单个逻辑行上发出，重写 javascript_maximum_signature_line_length 和 maximum_signature_line_length .

Added in version 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 .

Added in version 7.1.

.. js:data:: name

描述全局变量或常数。

.. js:attribute:: object.name

描述属性 name 的 object .

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

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