Допустимо ли объединять @file, @license и @author вверху файла, используя JSDOC? - PullRequest
0 голосов
/ 29 августа 2018

В начале файла обычно содержится отдельная лицензия:

/**
 * @license
 * Copyright (C) 2018 FOO.inc
 * license text
 */

Однако я хотел бы добавить @file с описанием файла, а также тегами @author.

По логике они также должны быть в начале файла, и действительно документация для @file состояний:

Тег @file предоставляет описание файла. Используйте тег в комментарии JSDoc в начале файла.

У меня вопрос: допустимо ли объединять их, как показано ниже, или текст лицензии должен быть автономным?

/**
 * @file sets up Foo
 * @author Foo <foo@foomail.com>
 * @license
 * Copyright (C) 2018 FOO.inc
 * license text
 */

Если нет, как правильно структурировать эти дескрипторы в файле?

...