2017-11-23 17 views
0

@param을 사용하여 올바르게 콜백을 문서화하는 방법을 알아낼 수 없으므로 Visual Studio 2017 intellisense에서이를 이해할 수 있습니다. 예를 들어Visual Studio intellisense 용 JSDoc에서 콜백 매개 변수를 문서화하는 방법은 무엇입니까?

:

/** 
* @param {string} file absolute path 
* @param {Function} callback called when done 
*/ 
function loadFile(path, callback) { 
    /// code 
} 

콜백이 그것을 문서화하는 방법을 인수 (Node.js를 스타일), 같은 Errorstring 받아?

답변

1

이 패턴이 작동합니다

/** 
* @param {string} file absolute path 
* @param {function(Error, string):void} callback called when done 
*/ 
function loadFile(path, callback) { 
    /// code 
} 

void 여기에 돌아올 수없는 값을 의미, 콜백 반환 값 (예 : 술어에 대한 {function(value):boolean})로 대체 할 수 있습니다.

잘 모르는 매개 변수 이름을 문서화하는 방법.

+0

당신은 내 영웅, @ tomáš-zato입니다. 콜백에 공식 JSDoc 표기법을 사용해 보았습니다. 나는이 답변을 여러 번 upvote 할 수 있었으면 좋겠다. –

+0

변수 이름과 설명으로 매개 변수에 주석을 달 수있는 방법을 알아낼 수 있다면 보너스를! –

+1

@KrisOye 나는 소원한다. 나는 성공하지 않고 모든 종류의 조합을 시도했다. –