JSDocs - 암시 적 매개 변수를 문서화하고

Question

내가 같은 기능을 문서화하는 방법 궁금 반환하는 방법 다음 :

var createInput = function() { 
    var type = this.type; 

    this.input = { 
    val: {}, 
    type: type 
    }; 
} 

을 기술적으로 this.type는 입력 매개 변수가되고 this.input이 개체에서 반환 무엇인가 . 어떻게 문서화하겠습니까?

Answer 1

인자를 취하고 부작용없이 어떤 값을 반환하도록 코드를 수정하십시오. 문서화하기 쉽다!

문제는 부작용에게 부작용를 문서화하는 방법보다는 을 방지하는 방법을 더 같이해야한다.

var createInput = function (type) { 
    return { 
    val: {}, 
    type: type 
    }; 
} 

this.input = createInput(this.type); 

Answer 2

sapithpocker에 의해 두 번째 링크의 리프잉이 잠재적 인 해결책을 제시하는 것으로 보입니다.

/** 
* The context of the current class. 
* @typedef {Object} ClassContext. 
* @property {string} type - Indicates type. */ 

/** 
* A method for doing something. 
* @param {...ClassContext} this - a {@link ClassContext} object. 
*/ 
function createInput() { /* Code */ } 

이 아니라, 용도가 현재 상황, 즉 this을 "소유"객체 각각의 방법에 대해 재사용 될 수 문서이고, DRY 원리를 따른다.