2014-12-11 14 views
7

Tôi đã có một lớp học, nơi các phương pháp cá nhân có thể được gọi là tĩnh nhưng sẽ trả về một thể hiện mới của lớp để chuỗi, ví dụ:Tư liệu một constructor riêng với JSDoc

var builder = ns 
    .setState('a', 'A') 
    .setState('b', 'B'); 

đâu Builder được định nghĩa là ví dụ:

/** 
* @module Builder 
*/ 

/** 
* @class Builder 
*/ 

/** 
* @private 
*/ 
function Builder() { 
    this.state = { 
    query: {} 
    }; 
} 
Builder.prototype = { 
    /** 
    * @param {string} k - The key 
    * @param {object} v - The value 
    * @return {Builder} 
    */ 
    setState: function(k, v) { 
    var that = (this instanceof Builder) ? this : new Builder(); 
    that[k] = v; 
    return that; 
    } 
    // Other properties and methods… 
} 

các constructor Builderbao giờ nghĩa vụ phải được gọi một cách rõ ràng theo mã người dùng và vì vậy tôi muốn nó không xuất hiện trong các tài liệu. Tuy nhiên, tất cả các kết hợp tôi đã thử với các thẻ JSDoc (ví dụ: @private, @constructs, v.v.) dường như không thể loại bỏ nó khỏi các tài liệu được tạo.

Trả lời

2

Bạn sẽ có thể sử dụng chỉ thị @ignore để đạt được điều này. Từ tài liệu:

Thẻ @ignore cho biết biểu tượng trong mã của bạn sẽ không bao giờ xuất hiện trong tài liệu. Thẻ này được ưu tiên hơn tất cả các thẻ khác.

http://usejsdoc.org/tags-ignore.html

Các vấn đề liên quan