Мне был передан веб-сайт, который использует документацию и условные обозначения кода в файлах javascript, которые выглядят следующим образом:
// !@TheFunctionNameFunc
function theFunctionNameFunc() {
...
}
, где единственное, что изменяется для каждого примера, - это «имя_функции»часть комментария - части «The» и «Func» - это не только то, что я выбрал для своего примера, но и то, что на самом деле содержится в коде.Я подумала, что, возможно, он использовался в автогенераторе документов, что объясняло соглашения, но я не вижу ничего подобного.
Кто-нибудь видел эту документацию раньше или знает, откуда она взялась?Соглашения о кодировании также немного необычны для меня, но я могу записать их в соответствии с личными предпочтениями.Комментарий !@ меня бросает - он кажется слишком конкретным, чтобы быть личным предпочтением.И я не могу понять, какое значение оно добавляет, поскольку оно просто повторяет имя функции и не предоставляет никакой другой информации, например, параметров или возвращаемых значений.Я покопался в Интернете и посмотрел на инструменты и соглашения JS по документации и не смог найти соответствия.
Мне частично любопытно, нахожусь ли я в неведении относительно какого-то нового тренда буткемпа кодирования или этопросто странность.