Visual Studio 2010 Javascript/Jquery Документация

Question

Окей, два вопроса:

1. Есть что-нибудь, как GhostDoc для JS?
2. Есть ли хорошие генераторы файлов справки, которые могут использовать как C# И Исходные файлы JS для создания документации? Похоже, что SandCastle не поддерживает веб-сайт, а не веб-проект с файлами .proj. И, насколько я могу судить, Natural Docs не поддерживает документацию в стиле Visual Studio ... так что это не сработает.

Я чувствую, что здесь что-то отсутствует. Я просто не могу поверить, что люди там комментируют свои JS вручную ... там должно быть что-то, не так ли?

Я искал высоко и низко. Я спрашиваю, как последнее средство. Пожалуйста, просто скажите мне, что я воняю при поиске и что есть простые решения! :-)

Answer 1

Вы дали это в качестве примера (было бы неплохо поставить его на вопрос правильно, может быть, мода придет и сделает это за вас, так как вы сможете редактировать свои собственные вопросы) и вы хотите знать, может ли блок /// <summary> автоматически вставляться в часть кода javascript, а не только в файлы .cs.

(function ($) { $.fn.helpfulTips = function (options) { 
    /// <summary> 
    /// Helpful Tips 
    /// </summary> 
    /// <param name="options">options</param> 
    /// <returns>jQuery</returns> 
    var defaults = { pointer: "#theArrow" }; 
    } 
}); 

я думаю, что это будет, но я просто ввести этот материал так быстро, что я не понимаю, что я печатаю это. Я тоже стараюсь делать это вручную, но мне вообще не нужно javadoc мой код (мы не используем javadocs), поэтому я не знаю, есть ли какие-либо автоматизированные инструменты, которые помогут в этом. Мне было любопытно, поэтому я нахожусь на этом посту (фаворитом), чтобы я мог видеть, есть ли у кого-нибудь другие хорошие мысли по этому поводу.

Answer 2

Вы можете использовать YuiDoc для генерации выходного документа JavaDoc. Я использовал его и был очень доволен выходом, который он предоставляет. Вы должны использовать их формат для комментариев, который не совпадает с форматом Visual Studio.

Answer 3

Вы должны ссылаться на все JS файлы будут использоваться в источнике, добавив:

/// <reference path="jquery-1.4.2.min.js" /> 
/// <reference path="facebox.js" /> 

верхней части вашего файла JavaScript. Таким образом, вы можете получить intellisense в javascript.

В последнее время некоторые js-фреймворки (например, jQuery) имеют файл -vsdoc.js для intellisense. Вы должны разместить файлы, в которых находятся ваши исходные файлы js; и имена их должны совпадать.

если имя ваших JS файлов «test.js», то файл -vsdoc должен быть назван: «тест-vsdoc.js»

Answer 4

Есть что-нибудь в этом списке, вам полезно: https://stackoverflow.com/questions/1221413/what-tools-are-available-for-documenting-javascript?