"@ что-то" слова в комментариях?

Question

Зачем эти "@word" в комментариях?

Я видел их в JavaScript и некоторых других языках. Есть ли какие-то стандарты с этим или это специально для какого-то конкретного инструмента? Может кто-нибудь открыть этот более продвинутый процесс комментирования, если есть еще что-то похожее на это. А во-вторых, почему этот пример начинается с двух звездочек?

Пример:

/**
 * Builds an absolute Path for a project, where
 * the files should be stored
 *
 * @param projectDir String
 * @param fileName String (optional)
 * @return {String} absolute Path
 */

Answer 1

Это может выглядеть как эстетическое комментирование с некоторыми предварительно отформатированными соглашениями.

Но эти комментарии на самом деле используются инструментами разработки для обеспечения автоматической генерации документации (например, JSDoc), синтаксической проверки и проверки типов или даже для получения директив компиляции (Google Closure minifier).

И 2 звездочки, и @something нотации являются соглашениями для этих инструментов разработки.

Поэтому, если вы никогда не будете использовать такие средства разработки, эта запись является чисто эстетической. Но если вы будете использовать эти инструменты, то это станет частью вашего рабочего процесса для использования автоматизированных процессов.

Answer 2

Нет, стандарта нет, но одним из самых популярных инструментов для комментариев в этом стиле является JSDoc, который свободно основан на комментариях JavaDoc Java.