Подтвердить что ты не робот

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

ОК, ДВА ВОПРОСА:

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

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

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

4b9b3361

ОТВЕТЫ

Ответ 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), поэтому я не знаю, есть ли какие-либо автоматизированные инструменты, которые помогут в этом. Мне было любопытно, поэтому я нахожусь на этом посту (фаворитом), чтобы я мог видеть, есть ли у кого-нибудь другие хорошие мысли по этому поводу.

Ответ 2

Вы должны указать все файлы 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 должен быть назван: "test-vsdoc.js"

Ответ 3

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