JSDoc 레퍼런스 해부하기 - 2

참고링크

https://jsdoc.app/

Use JSDoc: Index

 

Using namepaths with JSDoc 3

JSDoc 3 에서의 Namepaths

- 문서의 다른곳에 있는 JavaScript 변수를 참조할 때 해당 변수에 매핑되는 고유 식별자를 제공해야한다

- Namepath는 인스턴스, 스태틱 멤버 및 내부 변수를 명확하게 해준다

 

- 예시 : say 라는 같은 이름을 공유하는 인스턴스, 스태틱, 내부 메서드

 

/** @constructor */
Person = function() {
    this.say = function() {
        return "I'm an instance.";
    }

    function say() {
        return "I'm inner.";
    }
}
Person.say = function() {
    return "I'm static.";
}

var p = new Person();
p.say();      // I'm an instance.
Person.say(); // I'm static.
// there is no way to directly access the inner function from here

/* namepath 기본 문법
Person#say  // the instance method named "say."
Person.say  // the static method named "say."
Person~say  // the inner method named "say."
*/

 

documentation tag를 통한 코드 표현

▶ consider 메서드를 namepath로 표현하면 Person#Idea#consider 가 된다

▷ 예시

 

/** @constructor */
Person = function() {
    /** @constructor */
    this.Idea = function() {
        this.consider = function(){
            return "hmmm";
        }
    }
}

var p = new Person();
var i = new p.Idea();
i.consider();