@лицензия
Содержание
Синтаксис
@license <identifier>
Обзор
Тег @license указывает на лицензию программного обеспечения, которая применяется к любой части вашего кода.
Вы можете использовать любой текст для идентификации используемой лицензии. Если ваш код использует стандартную открытую лицензию, рассмотрите возможность использования соответствующего идентификатора из списка лицензий Software Package Data Exchange (SPDX).
Некоторые инструменты обработки JavaScript, такие как Google Closure Compiler, будут автоматически сохранять любой JSDoc комментарий, который включает тег @license. Если вы используете один из этих инструментов, вы можете добавить отдельный JSDoc комментарий, который включает тег @license, вместе со всем текстом лицензии, чтобы текст лицензии был включён в сгенерированные файлы JavaScript.
Примеры
/** * Utility functions for the foo package. * @module foo/util * @license Apache-2.0 */
/** * @license * Copyright (c) 2015 Example Corporation Inc. * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */
© 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-license.html