Есть ли какой-либо инструмент для комментария кода JavaScript? [закрытый]

Question

Есть ли какой-либо инструмент для комментария кода JavaScript? [закрытый]

Таким образом, разработчик делает хорошую работу, но беден при оценке количества времени для доставки? Я не уверен, что у Вас есть ситуация с наказанием на Ваших руках просто все же.

, Возможно, продвижение в течение некоторого времени, сделайте, чтобы он обошел Вас посредством своего процесса для оценки пункта доставки. Это может быть возможностью спросить его, почему шаги X, Y и Z берут определенные количества времени. Он может пересмотреть свои оценки просто путем выполнения осуществления в том, что является почти наверняка более медленным темпом.

11

javascript visual-studio comments

задан Joel Coehoorn 23 March 2010 в 00:31

5 ответов

Другие вопросы по тегам:

javascript visual-studio comments

Похожие вопросы:

score 7 · Answer 1

Yes (but more like Javadoc) - look at JSDoc Basically you use Javadoc-like special syntax in your comments e.g. @param like in the following example and then parser will generate good looking HTML output for you

/**
* Shape is an abstract base class. It is defined simply
* to have something to inherit from for geometric 
* subclasses
* @constructor
*/
function Shape(color){
    this.color = color;
}

score 2 · Answer 2

Короткий ответ: нет, нет ничего, что автоматизирует документацию. В завершение вы получаете добавление комментариев вручную с помощью чего-то вроде jsdoc-toolkit , которое позволяет встраивать документацию в HTML-страницы.

Также есть документация intellisense для javascript для javascript, который выглядит так (обратите внимание, что он находится внутри функции)

function example(var myParameter){
    /// <summary>This is an example function</summary>
    /// <param name="myParameter" type="String">All your string are belong to us.</param>
    /// <returns type="Boolean" />

   return !!myParameter;
}

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

score 0 · Answer 3

I haven't personally used it, but jsdoc-toolkit seems to be what you're after.

0

ответ дан 3 December 2019 в 10:04

score 0 · Answer 4

I haven't used it for JavaScript, but Doxygen has a filter that allows it to (at least to some extent) be used to document JavaScript. It might be worth looking into, especially if you are using other languages that are also supported by Doxygen, so you can have one tool for everything.

It appears that JSUnit uses Doxygen for its documentation.

score 0 · Answer 5

Sandcastle, похоже, также поддерживает JavaScript, см. http://blogs.msdn.com/sandcastle/archive/2007/06/28/scriptdoc-1-0-for-extractiong- javascript-код-комментарии-сейчас-доступен-на-codeplex.aspx . Я использую его для C #, поскольку проект NDoc является тостом, но еще не пробовал его для JavaScript.