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

Question

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

/// <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) 
{ 
    ... 
} 

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

/// <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

Answer 1

Да (но больше как Javadoc) - look at 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; 
} 

Answer 2

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

Answer 3

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

Answer 4

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

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

Answer 5

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

Answer 6

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