Есть ли инструмент для комментирования кода JavaScript?

Есть ли какой-либо инструмент для комментирования javascript, как в С#, например, призрачный документ.

/// <summary>
///   Method to calculate distance between two points
/// </summary>
/// <param name="pointA">First point</param>
/// <param name="pointB">Second point</param>
function calculatePointDistance(pointA, pointB)
 { 
    ... 
 }

есть инструмент автоматического добавления комментариев, как указано выше. как в коде С# код dhost:

/// <summary>
///   Method to calculate distance between two points
/// </summary>
/// <param name="pointA">First point</param>
/// <param name="pointB">Second point</param>
private void calculatePointDistance(pointA, pointB)
{
  .....
}

Я хочу сделать подобное на стороне клиента, javascript

Ответы

Ответ 1

Да (но больше похоже на Javadoc) - посмотреть JSDoc В основном вы используете специальный синтаксис Javadoc в своих комментариях, например. @param, как в следующем примере, а затем синтаксический анализатор создаст для вас хороший вывод HTML

/**
* 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;
}

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

Ответ 3

Интересно, почему никто не упомянул DocStubsJS

Ответ 4

Я лично его не использовал, но jsdoc-toolkit кажется тем, что вы после.

Ответ 5

Я не использовал его для JavaScript, но Doxygen имеет фильтр, который позволяет использовать его (по крайней мере, в некоторой степени) для документирования JavaScript. Возможно, стоит обратить внимание, особенно если вы используете другие языки, которые также поддерживаются Doxygen, поэтому у вас может быть один инструмент для всего.

Похоже, что JSUnit использует Doxygen для его документации.