Комментирование функций JavaScript в виде строк документации Python

Question

Это действительно JavaScript, чтобы написать что-то вроде этого:

function example(x) {
    "Here is a short doc what I do.";
    // code of the function
}

Строка на самом деле ничего не делает. Есть ли какая-то причина, по которой нельзя так комментировать свои функции в JavaScript?

Два момента, о которых я мог подумать во время написания вопроса:

• Строковый литерал должен быть инициирован, что может быть дорогостоящим в долгосрочной перспективе

• Строковый литерал не будет распознан как снимаемый JS минифайерами

Какие-нибудь еще точки?

Редактировать: Почему я поднял эту тему: я нашел что-то подобное в Блог Джона Ресига , где новый стандарт ECMA 5 использует неназначенный строковый литерал для включения "строгого Режим". Теперь я был заинтересован в том, чтобы просто оценить, могут ли быть какие-либо применения или опасности в создании такой документации.

Answer 1

Нет смысла делать это в Javascript. В Python строка становится доступной как __doc__ член функции, класса или модуля. Таким образом, эти строки документов доступны для самоанализа и т. Д.

Если вы создаете подобные строки в Javascript, вы не получаете никакой выгоды от использования комментария, плюс вы получаете некоторые недостатки, такие как всегда присутствующая строка.

Answer 2

Я искал способ добавить многострочные строки в мой код без засорения \ n. Похоже, этот модуль отвечает всем требованиям: https://github.com/monolithed/doc

К сожалению, комментарии не выдержат минификации, но я полагаю, что вы могли бы написать задачу компиляции для преобразования строк документации в формат \ n.