AjaxDoc - 如何配置?

时间:2013-01-18 13:25:18

标签: javascript documentation sandcastle shfb

我想记录我的项目。一切都运行良好,但我无法让AjaxDoc正常工作。

拜托,有人可以给我一些简短的教程如何使用它们吗?

我在Visual Studio中集成了SHFB。 然后我从http://ajaxdoc.codeplex.com/下载了WebApp项目,并将它们作为现有网站添加到我的解决方案中。我已经构建了这个站点,他的URL写入了AjaxDoc插件。

现在,AjaxDoc默认配置为从MicrosoftAjax.js获取注释,它对我有用。 但我尝试添加自己的MyJavaScript.js并在Projects文件夹中创建MyJavaScript.project.xml但它不起作用。

JScript.project.xml:

<?xml version="1.0" encoding="utf-8" ?>

<project xmlns:scriptdoc="http://www.w3.org/2001/XMLSchema-instance"
  scriptdoc:noNamespaceSchemaLocation="ScriptDocProject.xsd">
  <scripts>
    <script path="projects/JScript.js"/>
  </scripts>
  <namespaces>
    <namespace>TestScript</namespace>
  </namespaces>
</project>

JScript.js:

    /// <reference path="_references.js" />

    Type.registerNamespace("TestScript");

    TestScript.JavaScriptClass = function demoScript$JavaScriptClass() {
        /// <summary>
        /// This is a summary for the singleton
        /// </summary>

        /// <field name="field1" type="String" >This is a demo field.</field>

        this._property1Value = 1;
    }

    TestScript.JavaScriptClass.prototype = {
        method: function (param1, param2) {
            /// <summary>
            /// This is a demo method of <see cref="JavaScriptClass" />.
            /// </summary>
            /// <param name="param1" type="Number" integer="true">This is parameter 1 of the demo method <see cref="JavaScriptClass.method" />.</param>
            /// <param name="param2" type="String">This is parameter 2 of the demo method <see cref="JavaScriptClass.method" />.</param>
            /// <returns type="String">Returns a demo result.<returns>
            return "Hello world";
        },
        get_Property1: function () {
            /// <value type="Number" integer="true">This is a demo property.</value>
            return this._property1Value;
        },
        set_Property1: function (value) {
            this._property1Value;
        },
        field1: null
    };

    demoScript.JavaScriptClass.registerClass("TestScript.JavaScriptClass");

我从互联网上发现的一些项目中复制了这个...

我做错了什么?我怎么能评论我自己的项目,而不仅仅是AjaxDoc / Projects文件夹中的脚本?

感谢您的回复。

0 个答案:

没有答案