JSDoc에 대한 기술을 익히려고 노력 중이며이 방법이 있습니다.
/**
* Cleanup step.
*
* @return {Void}
*/
beforeDestroy() {
window.removeEventListener('resize', this.onResize);
},
그것은 맞아 보이지만 일반적인 JavaScript 코딩 스타일의 경우 다음과 같습니다.
beforeDestroy() {
return window.removeEventListener('resize', this.onResize);
},
가능한 경우 항상 함수 호출을 반환하려고하기 때문입니다 (꼬리 호출 최적화와 관련된 함수 프로그래밍 습관으로). 이것은 함수 호출을 반환하는 함수를 문서화하는 방법에 대한 질문으로 이어집니다.
내 순진한 추정은 다음과 같을 것입니다.
/**
* Cleanup step.
*
* @return {(String, Function) => Void}
*/
beforeDestroy() {
return window.removeEventListener('resize', this.onResize);
},
나는 이런 종류의 일에 대해 올바른 / 정상이 무엇인지 듣고 싶습니다. 함수가 "void를 반환하는 함수 호출을 반환"하거나 "문자열을 반환하는 함수 호출을 반환"과 같은 다른 것을 문서화하는 방법을 알고 싶습니다.
사람들이 이전에 카레 기능에 대해 묻는 것을 본 적이 있는데, 문서화와 관련하여 이런 종류의 기능은 사람이 필요로하는 기능이 얼마나 많을까요?
이와 같은 것은 나에게 불합리한 것 같습니다.
* @return {(String, Function) => (Object) => Void}
"문서"가 향후 실행에 대해 얼마나 많은 인식을 필요로합니까?
당신은을 사용 @callback(또는 @function); 참조 : https://jsdoc.app/tags-callback.html
예를 들면 다음과 같습니다.
/**
* This callback is a returned event listener
* @callback removedCallback
* @param {number} nameOfNumberParam
* @param {string} nameOfStringParam
*/
/**
* Cleanup step.
*
* @return {removedCallback} - The removed callback
*/
beforeDestroy() {
return window.removeEventListener('resize', this.onResize);
},
그러나 당신은 또한 스스로에게 물어보고 싶을 것입니다 ... 이것은 정말 누구에게나 유용할까요, 아니면 문서화하기 위해 문서화하고 있습니까? 당신이 정말로 원하는 것이 타입 시스템이라면, Typescript는 훨씬 더 잘 할 수 있습니다 (문서화 외에도 많은 이점을 제공합니다).
문서화 만하는 경우 청중을 고려하십시오. 일부 청중에게는 위의 스타일이 가장 좋지만 다른 많은 사람들은 더 간단한 방식으로 제공 될 수 있습니다.
/**
* Cleanup step.
*
* @return function - The removed callback
*/
beforeDestroy() {
return window.removeEventListener('resize', this.onResize);
},
이 기사는 인터넷에서 수집됩니다. 재 인쇄 할 때 출처를 알려주십시오.
침해가 발생한 경우 연락 주시기 바랍니다[email protected] 삭제
몇 마디 만하겠습니다