構文
@license <identifier>
概要
@license
タグは、コードの該当する部分に適用するソフトウェアライセンスを識別します。
使用するライセンスを識別するために任意のテキストを使用できます。コードで標準的なオープンソースライセンスを使用している場合は、ソフトウェアパッケージデータ交換(SPDX)ライセンスリストから適切な識別子を使用することを検討してください。
Google のクロージャコンパイラなどの JavaScript 処理ツールの中には、@license
タグを含む JSDoc コメントを自動的に保持するものもあります。これらのツールのいずれかを使用している場合は、@license
タグとライセンスの全文を含むスタンドアロンの JSDoc コメントを追加することを検討してください。そうすることで、ライセンステキストが生成された 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.
*/