로컬로 정의되지 않은 JSDoc에서 함수를 문서화 할 수 있습니까?

Question

내 코드에서 두 번있는 기본 패턴은 exports.thing = thingFromSomewhereElse이고, 나는 자신을 정의한 것처럼 thingFromSomewhereElse의 기능 멤버를 문서화하려고합니다. 하지만 실제로는 thing.functionName = function() {...} 없이는 어떻게되는지 알 수 없습니다. @callback 태그를 사용하려고하면 JSDoc은이를 구성원 대신 유형 정의로 분류합니다. 개체 구성원으로 올바르게 표시되도록하는 방법이 있습니까?

Answer 1

이 작업은 @name JSDoc 태그를 사용하여 수행 할 수 있습니다. 이 태그는 JSDoc에서 인식하지 못하는 것에 대한 주석을 작성하는 데 사용됩니다. @kind 태그는 문서화되는 것이 실제로 함수임을 나타 내기 위해 사용되어야하므로 @param 및 @return과 같은 기능별 태그가 올바르게 작동합니다. 주어진 예제에서 함수는 다음과 같은 주석을 사용하여 문서화됩니다.