Có công cụ nào để nhận xét mã JavaScript không?

Question

Có công cụ nào để nhận xét javascript vì nó nằm trong C# như ghost doc hay không.

/// <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ó bất kỳ công cụ nào để tự động thêm nhận xét như trên. như trong C# mã ma doc đã làm:

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

tôi muốn làm tương tự ở phía Client, javascript

Answer 1

Có (nhưng nhiều hơn như Javadoc) - look at JSDoc Về cơ bản bạn sử dụng cú pháp đặc biệt Javadoc giống như trong bình luận của bạn @param như trong ví dụ sau và sau đó phân tích cú pháp sẽ tạo ra đẹp trai đầu ra HTML cho bạn

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

tôi đã không cá nhân sử dụng nó, nhưng jsdoc-toolkit có vẻ là những gì bạn đang sau.

Answer 3

Câu trả lời ngắn gọn là không, không có gì tự động hóa tài liệu. Các đóng bạn nhận được là tự thêm ý kiến ​​với một cái gì đó như jsdoc-toolkit cho phép xây dựng tài liệu vào các trang html.

Có tài liệu IntelliSense cho javascript cho javascript là tốt, mà trông như thế này (chú ý đó là bên trong hàm mặc dù)

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

Bạn cũng có thể tạo các đoạn cho các tập tin javascript. Tôi sẽ chỉ tạo một vài đoạn điền các tài liệu phổ biến (bất kỳ loại nào bạn thích) và sau đó bạn có thể chỉ cần gõ đoạn mã và nó sẽ điền vào hầu hết tài liệu cho bạn.

Answer 4

Tôi chưa sử dụng nó cho JavaScript, nhưng Doxygen has a filter cho phép nó (ít nhất là ở một mức độ nào đó) được sử dụng để làm tài liệu JavaScript. Nó có thể là giá trị xem xét, đặc biệt là nếu bạn đang sử dụng các ngôn ngữ khác cũng được hỗ trợ bởi Doxygen, vì vậy bạn có thể có một công cụ cho tất cả mọi thứ.

Dường như JSUnit sử dụng Doxygen cho tài liệu của nó.

Answer 5

Sandcastle cũng hỗ trợ JavaScript, xem http://blogs.msdn.com/sandcastle/archive/2007/06/28/scriptdoc-1-0-for-extractiong-javascript-code-comments-is-now-available-at-codeplex.aspx. Tôi sử dụng nó cho C# kể từ khi dự án NDOC là bánh mì nướng, nhưng chưa thử nó cho JavaScript. Tôi đã từng sử dụng JSDoc được đề cập ở trên.

Answer 6

Tôi tự hỏi tại sao không ai đề cập đến DocStubsJS