DocsBuilder生成JSdoc

Clare 12年前發布 | 1K 次閱讀 2.5beta版

DocsBuilder是.NET編寫的用來生成 C# API文檔的工具。而DocsBuilder的此次更新，增加了對JavaScript的支持。今天，筆者就測試一個它生成JavaScript API文檔的結果。

下載地址：http://www.shinater.com/DocsBuilder/DocsBuilderGUI.zip

DocsBuilder主頁：http://www.shinater.com/DocsBuilder.xhtml

像JsDoc Toolkit一樣，DocsBuilder也使用javadoc注釋規范，那么我們就先注釋一個函數試試。

/**
* 測試的類。
* @param name 參數名。
*/
function MyClass(name){
}

生成的文檔的截圖：

按照DocsBuilder的幫助介紹，可以為參數指定參數，方法是在注釋文本前加上(類型)，我們加上類型試試。

/**
* 測試的類。
* @param name (String)參數名。
*/
function MyClass(name){
}

確定被識別了，效果還不錯。接下來，我們為這個類添加屬性和方法。

/**
* 測試的類。
* @param name (String)參數名。
*/
function MyClass(name){
        /**
         * 這是一個屬性。
        */
        this.name = name;
        /**
         * 這是一個方法。
        */
        this.method = function(){
               alert(this.name);
        }
}

點擊 method 后的效果：

可以看出屬性和方法的聲明都轉換成原型定義了，那么我們就使用原型添加一個復雜的方法。

/**
* 測試方法2。
* @param param1 (String)參數1。
* @param param2 (String)參數2。
* @return (Number)參數1的長度。
* @throws Error 參數1為null。
*/
MyClass.prototype.method2 = function(param1,param2){
return param1.length;
}