Spec-Zone.ru › JSDoc

@author

Table of Contents

  • Syntax
  • Overview
  • Examples
  • Related Links

Syntax

@author <name> [<emailAddress>]

Overview

The @author tag identifies the author of an item. In JSDoc 3.2 and later, if the author's name is followed by an email address enclosed in angle brackets, the default template will convert the email address to a mailto: link.

Examples

Documenting the author of an item
/**
 * @author Jane Smith <jsmith@example.com>
 */
function MyClass() {}

Related Links

  • @file
  • @version

© 2011–2017 the contributors to the JSDoc 3 documentation project
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://jsdoc.app/tags-author.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API