Tài liệu JavaScript từ VSDoc

Question

Có công cụ nào ở đó tạo ra Tài liệu HTML của JavaScript chung được ghi thành cú pháp theo cú pháp VSDoc (không có cú pháp giống javadoc!)?

Không có khả năng thay đổi thành cú pháp JavaDoc, vì chúng tôi viết JS trong Visual Studio và VS chỉ hỗ trợ nhận xét VSDoc cho JS.

Đối với MS ASP.NET AJAX là một công cụ có sẵn, nhưng nó không hoạt động với JS chung.

Ví dụ:

$m = { 
    registerControlType: function(controlPrototype, baseControlType) { 
     /// <summary> 
     /// Summary 1 
     /// </summary> 
     /// <param name="controlPrototype" type="Object"> 
     /// Param 1 
     /// </param> 
     /// <param name="baseControlType" type="String" optional="true"> 
     /// Param 2 
     /// </param> 
    }, 

    requestData: function(control, success, failure, postData, plainResponse, maximumSecondsToCache) { 
     /// <summary> 
     /// Summary 2 
     /// <para></para> 
     /// <para>Additional Signatures:</para> 
     /// <para>1. requestData(control, success, [failure], [plainResponse], [maximumSecondsToCache])</para> 
     /// <para>2. requestData(control, success, [postData], [plainResponse], [maximumSecondsToCache])</para> 
     /// <para>3. requestData(control, success, [plainResponse], [maximumSecondsToCache])</para> 
     /// <para>4. requestData(object)</para> 
     /// </summary> 
     /// <param name="control" type="object"> 
     /// Param 1 
     /// </param> 
     /// <param name="success" type="Function"> 
     /// Param 2 
     /// </param> 
     /// <param name="failure" type="Function" optional="true"> 
     /// Param 3 
     /// </param> 
     /// <param name="postData" type="object" optional="true"> 
     /// Param 4 
     /// </param> 
     /// <param name="plainResponse" type="boolean" optional="true"> 
     /// Param 5 
     /// </param> 
     /// <param name="maximumSecondsToCache" type="Number" optional="true"> 
     /// Param 6 
     /// </param> 
    } 
}; 

Answer 1

Bạn chỉ cần bao gồm tập tin javascript của bạn như tham chiếu đến hàng đầu trong các tập tin và bạn sẽ nhận được IntelliSense.

/// <reference path="path-to/your-script.js" /> 

Chú ý: báo cáo tham khảo phải đặt trước tất cả các nội dung khác trong các ý kiến ​​tập tin thậm chí bình thường.

Đối với kiểm tra việc tạo tự động: JsDoc Toolkit (http://code.google.com/p/jsdoc-toolkit/)

UPDATE:

lẽ bạn có thể sử dụng YUI Doc (http://developer.yahoo.com/yui/yuidoc/)

trọng.