Czy istnieje narzędzie do komentowania kodu JavaScript?

Question

Czy istnieje narzędzie do komentowania javascript, ponieważ jest w C# jak ghost doc.

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

istnieje narzędzie do automatycznego dodawania komentarzy, jak wyżej. jak w C# duchów doc zrobił:

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

chcę zrobić podobny stronie klienta javascript

Answer 1

Tak (ale bardziej jak Javadoc) - look at JSDoc Zasadniczo użyć Javadoc podobny specjalnej składni w twoje komentarze, np @param jak w poniższym przykładzie, a następnie parser będzie generować dobre patrząc wyjście HTML dla ciebie

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

Ja osobiście nie używany, ale jsdoc-toolkit wydaje się być co Ty jesteś po.

Answer 3

Krótka odpowiedź brzmi: nie, nic nie automatyzuje dokumentacji. Zamknięcia, które otrzymujesz, są dodawane ręcznie za pomocą czegoś takiego, jak jsdoc-toolkit, co pozwala budować dokumentację na stronach html.

Jest intellisense dokumentacja JavaScript javascript, jak również, który wygląda następująco (zauważ, że jest wewnątrz funkcji chociaż)

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

Można również tworzyć fragmenty dla plików javascript. Po prostu utworzę kilka fragmentów wypełniających typowe dokumentacje (dowolny typ, który preferujesz), a następnie możesz po prostu wpisać fragment i wypełni on większość dokumentacji.

Answer 4

Nie użyłem go do JavaScript, ale Doxygen has a filter, który pozwala mu (przynajmniej w pewnym stopniu) być używane do dokumentowania JavaScript. Warto przyjrzeć się, zwłaszcza jeśli używasz innych języków, które są również obsługiwane przez Doxygen, więc możesz mieć jedno narzędzie do wszystkiego.

Wygląda na to, że JSUnit używa Doxygen do swojej dokumentacji.

Answer 5

Sandcastle wydaje się również obsługiwać JavaScript, zobacz http://blogs.msdn.com/sandcastle/archive/2007/06/28/scriptdoc-1-0-for-extractiong-javascript-code-comments-is-now-available-at-codeplex.aspx. Używam go do C#, ponieważ projekt NDoc jest toast, ale jeszcze nie próbowałem go dla JavaScript. Użyłem wcześniej wspomnianego JSDoc.

Answer 6

Zastanawiam się, dlaczego nikt nie wspomniał DocStubsJS