2012-09-19 2 views
3

JavaScript 나 PHP와 같은 동적 언어에서는 함수에 하나의 인수 만 전달하는 것이 일반적입니다. 이 인수는 모든 옵션을 캡슐화하는 객체입니다. ScriptDoc (또는 유사)을 사용하여 이러한 옵션을 문서화하는 가장 좋은 방법은 무엇입니까?객체를 인수로 사용하는 JS 함수 문서화

/** 
* @param {Object} o  Object containing function params. 
* @param {String} o.bar Example String param. 
* @param {Number} o.baz Example Number param. 
*/ 
function foo(o) { 
} 

상세 정보 등록 JSDoc의 TagParam documentation의 섹션으로 매개 변수에서 찾을 수 있습니다 : 다음과 같이

답변

2

JSDoc 그것을 수행 할 수 있습니다 사용.

관련 문제