0

저는 상당히 많은 클라이언트 자바 스크립트 애플리케이션에서 작업 중이며 문서를 추가하려고합니다. 나는 인텔리 센스 (Intellisense)에 의해 픽업되도록 vsdoc 스타일로 갔지만 반환 객체를 정의하는 데 문제가있었습니다.Javascript vsdocs의 요소를 반환합니다.

returnObject() : 나는 같은 코드를 작성할 수 있도록하고 싶습니다

function returnObject() { 
    return { 'prop1': 'value1', method: function(){return 1;}}; 
} 

:로

은 함수 정의 가정하면. 그리고 후에. Intellisense에서 'prop1'과 'method'를 볼 수 있습니다. 다른 곳에서 객체를 정의하지 않아도 가능합니까?

반환 객체는 어떻게 정의합니까? 나는 문서 here을보고 있었지만, 지금까지는별로 도움이되지 않았습니다. jQuery vsdoc을 보면 거의 항상 jQuery 객체 또는 간단한 유형을 반환한다는 것을 알 수 있습니다. amplify vsdoc에서 Object 또는 undefined를 반환 한 다음 텍스트에서 해당 객체가 어떻게 보이는지 설명합니다.

반환 객체의 모양을 정의하기 위해 /// 요소 스타일 문서를 사용할 수 있습니까? 누구든지이 샘플을 가지고 있습니까?

답변

0

Visual Studio 2012 이상에서는이 시나리오에 대해 vsdoc 파일이 필요하지 않습니다.

vsdoc은 내부 자바 스크립트 인터프리터가 코드를 실행할 수없는 상황 (예 : 웹 서비스)에 유용합니다.

vsdoc 파일은 jsdoc 스타일 주석이 코드에서 사용될 때 유용하며 기본 코드 파일에 2 개의 주석 형식을 갖고 싶지 않습니다. Jquery는 이것의 좋은 예입니다.

또한 vsdoc 파일은 이제 Intellisense 파일이라고도합니다. 그러나 개념은 여전히 ​​동일합니다.

inteliisense

사용 인라인 코멘트 :

+0

와우, 당신은 전적으로 옳습니다! 내가 지나치게 복잡하게 만든 것 같아. 그렇다면 로컬/애플리케이션 JS 코드를 '문서화'할 수있는 실질적인 이점이 없으며 jsdoc을 배포 할 수있는 API 문서화에 더 많이 사용해야한다고 생각하십니까? –

+0

답변을 업데이트했습니다. 간접적이지만, 귀하의 질문을 분명히해야합니다. –

관련 문제