@use JSDoc

语法

@license <标识符>

概述

@license 标记标识适用于代码任何部分的软件许可证。

你可以使用任何文本来标识你正在使用的许可证。如果你的代码使用标准的开源许可证,请考虑使用 软件包数据交换 (SPDX) 许可证列表 中的适当标识符。

一些 JavaScript 处理工具(如 Google 的 Closure Compiler)将自动保留任何包含 @license 标记的 JSDoc 注释。如果你正在使用其中一种工具,你可能希望添加一个包含 @license 标记的独立 JSDoc 注释,以及许可证的全部文本,以便许可证文本将包含在生成的 JavaScript 文件中。

示例

在 Apache License 2.0 下分发的模块
/**
 * Utility functions for the foo package.
 * @module foo/util
 * @license Apache-2.0
 */
包含完整 MIT 许可证的独立 JSDoc 注释
/**
 * @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.
 */