文件开头通常包含独立许可证:
any
但是,我想添加totalLoanBalance = pow(interestRateAndPrincipal, yearsOutstanding) * LoansTaken;
以及文件说明以及/**
* @license
* Copyright (C) 2018 FOO.inc
* license text
*/
标签。
从逻辑上讲,这些也应该位于文件的顶部,并且实际上@file
的文档位于以下位置:
@author
标记提供了文件描述。在文件开头的JSDoc注释中使用标记。
我的问题是,按以下说明组合它们是否是可接受的做法,或者许可文本是否应该是独立的。
@file
如果没有,那么在文件中构造这些描述符的适当方法是什么?