Блог

Главная - Вопросы по программированию - Что означает @code при закрытии Google?

Что означает @code при закрытии Google?

#javascript #google-closure-compiler #google-closure-library

#javascript #google-closure-compiler #google-закрытие-библиотека

Вопрос:

Пример здесь:

 * An implementation of {@code goog.events.Listenable} with full W3C
* EventTarget-like support (capture/bubble mechanism,

https://developer.pubref.org/static/apidoc/global/closure/goog/events/EventTarget.html

Я могу догадаться, что это значит, но где я могу найти его точное определение? Я проверил все документы с аннотациями к закрытию Google, но не смог найти. Спасибо 🙂

Комментарии:

1. Я думаю, что @code — это тег Javadoc, в основном означающий, что текст внутри должен обрабатываться не как HTML, а как блок кода. Но в данном случае я думаю, что это просто для того, чтобы текст выглядел по-другому во время документации как goog.events. Возможность прослушивания хороша в HTML.

2. Кит прав и должен написать ответ, в котором говорится об этом. Это может быть код, который был преобразован из Java в Javascript с помощью этих старых тегов Javadoc. В более поздней библиотеке закрытия для документации используется code markdown, а документация генерируется с помощью Dossier

Ответ №1:

Обновлено

Согласно моему новому пониманию; Поскольку JSDoc поддерживает markdown. Поэтому {@code FooBar} устарел в пользу обратных тиков `FooBar` .

Старый

Вы можете увидеть выходные данные документов, о которых вы спрашивали, на странице документации API закрытия для goog.events.EventTarget.

При отображении JSDoc тег @code приведет к отображению кода в скобках в качестве <code></code> элемента.

Источник: js-досье

Есть также гораздо лучшая документация из JavaDocs… Документы:

{@code text}

  • Эквивалентно {@literal} .

  • Отображает текст шрифтом code, не интерпретируя текст как HTML-разметку или вложенные теги javadoc. Это позволяет использовать обычные угловые скобки (< и > ) вместо HTML-объектов (< и > ) в комментариях к документу, например, в типах параметров (), неравенствах (3 < 4) или стрелках (<-). Например, текст комментария к документу:

     {@code A<B>C}

    отображается на сгенерированной HTML-странице без изменений, как:

     A<B>C

    Примечательным моментом является то, что он не интерпретируется как выделенный жирным шрифтом и написан шрифтом code.
    Если вы хотите получить ту же функциональность без шрифта code, используйте {@literal} .

Источник: docs.oracle.com

Комментарии:

1. Просто в качестве продолжения, это чисто для документации и не имеет особого значения для компилятора закрытия.