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

Question

Допустимо на JavaScript написать что-то подобное:

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

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

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

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

• Строковый литерал не будет распознан как удаляемый с помощью JS minifiers

Есть еще какие-нибудь замечания?

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

Answer 1

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

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

Answer 2

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

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