JavaScript documentation from VSDoc

Is there a tool out there that generates HTML documentation for common JavaScript that is documented in VSDoc syntax (without javadoc! Syntax!)?

It is not possible to change the syntax of JavaDoc, because we are writing JS in Visual Studio, and VS only supports VSDoc comments for JS.

For MS, ASP.NET AJAX is a tool available, but it does not work with common JS.

Example:

$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>
    }
};
+5
source share
1 answer

You just need to include your javascript file as a link to the top of the file and you will get intellisense.

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

Important: Link operators must precede all other content in normal files.

: JsDoc Toolkit (http://code.google.com/p/jsdoc-toolkit/)

UPDATE:

, YUI Doc (http://developer.yahoo.com/yui/yuidoc/)

.

0

All Articles