@license
描述: 标识你的代码采用何种软件许可协议。
语法
@license <identifier>
概述
@license
标签标识你的代码采用何种软件许可协议。
你可以用任何文本来明确您所使用的许可证。如果您的代码使用一个标准的开源许可,考虑使用 Software Package Data Exchange (SPDX)许可列表中合适的标识符。
一些javascript处理工具,如谷歌的 Closure Compiler,会自动保留包含@license
标签的JSDoc注释块。如果您在使用这些工具之一,您可能希望增加一个包含@license
标签的独立的JSDoc注释块,后面加上许可的全部文本,从而使许可证文本将被包含在生成的JavaScript文件中。
Examples
例如,这是在Apache 2.0 许可下分发的模块:
/**
* Utility functions for the foo package.
* @module foo/util
* @license Apache-2.0
*/
一个独立的JSDoc注释块,包含完整的MIT许可:
/**
* @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.
*/