Какие инструменты доступны для документирования плагинов jQuery? [закрытый]
Рабина-Карпа поиск по нескольким шаблонам представляется самым быстрым.
3 ответа
Вы смотрели Natural Docs ? Возможно, у него не очень много явной поддержки JavaScript, но в любом случае он неплохо справляется. Конечно, вы можете обмануть его, чтобы он не понимал код, но если вы хорошо с ним поиграете, это может быть чертовски полезный инструмент.
Инструменты документации Javascript все еще относительно незрелы, поэтому не существует более 50 таких инструментов, как, например, JavaDoc, а те, которые существуют, не обрабатывают сложные случаи, такие как плагины jQuery. (или, по крайней мере, ни одного из тех, что я когда-либо видел).
Однако Javascript - чрезвычайно гибкий язык, поэтому вы можете просто переписать свои плагины таким образом, чтобы ваш инструмент документации счастлив.
Например, вместо:
(function($) {
$.yourMethod = function() {/* do something */}
})(jQuery);
вы можете использовать:
function yourMethod = function() {
/* do something */
}
(function($) {
$.yourMethod = yourMethod;
})(jQuery);
delete yourMethod
или просто:
jQuery.yourMethod = function() {
/* do something */
}
Эти два варианта не совсем идентичны; первая перезапишет любую существующую функцию yourMethod, а вторая не будет иметь приятной "конфиденциальности" стандартного формата плагина. В зависимости от того, для чего вы пишете этот плагин, эти проблемы могут иметь для вас значение, а могут и не иметь значения.
Если нет, то изменение стиля вашего кода может быть жизнеспособным способом сделать ваш JSDoc анализируемым. Если нет ... удачи в поиске достаточно зрелого инструмента JSDoc (или написании собственного): -)
Я использую Visual Studio XML комментарии: http://weblogs.asp.net/bleroy/archive/2007/04/23/the-format-for-javascript-doc-comments.aspx