来自VSDoc的JavaScript文档 [英] JavaScript Documentation from VSDoc

问题描述

有没有一个工具生成HTML文档的通用JavaScript，它记录在 VSDoc 语法（ no javadoc-like syntax！）？

Is there a tool out there which generates a HTML-Documentation of generic JavaScript which is documented in VSDoc syntax (no javadoc-like syntax!)?

没有可能更改为类似JavaDoc的语法，因为我们在Visual Studio中编写JS，VS仅支持JS的VSDoc注释。

There is no possibility to change to a JavaDoc like syntax, because we're writing JS in Visual Studio and VS supports only VSDoc comments for JS.

对于MS ASP.NET AJAX是一种可用的工具，但它不适用于通用JS。

For MS ASP.NET AJAX is a tool available, but it is not working with generic JS.

示例：

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

推荐答案

您只需要将您的javascript文件作为参考文件中的顶部，您将获得智能感知。

You just need to include your javascript file as reference to the top in the file and you'll get intellisense.

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

重要提示：引用语句必须先于文件中的所有其他内容 - 甚至正常评论。

Important: Reference statements must precede all other content in the file-even normal comments.

自动创建检查： JsDoc工具包（ http://code.google.com/p/jsdoc-toolkit/ ）

更新：

也许您可以使用 YUI文档 （ http://developer.yahoo.com/yui/yuidoc/ ）

问候。

这篇关于来自VSDoc的JavaScript文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！