2010-04-23 9 views
7

을 사용하여 msdn 유형 문서를 생성하는 데 사용할 수있는 도구가 있습니까?자바 스크립트에서 msdn 문서를 생성하는 방법은 무엇입니까? 바람직하게는 sandcastle

나는 최근에 sandcastle을 가지고 놀기 시작했고 scriptdoc이라는 도구에 익숙해졌지만 aptana에 흡수되었고 실제로 aptana 스튜디오를 사용하고 싶지 않습니다.

내가 지금까지 찾을 수있는 것은 javascript 파일에서 주석을 추출하는 펄 스크립트 인 jsdoc이지만 여전히 더 나은 적합을 찾고 있습니다. jsdoc에서 생성 된 XML은 모래 완료 일치하지 않거나 어쩌면 내가 뭔가를 누락 나의 초기 테스트에서

그것은

도움이 ... 보인다?

답변

0

vsdoc을 사용하여 주석을 달아야합니다 ... 구문은 C# vsdoc과 비슷하지만, 주석은 직전에 대신 문서화하고있는 함수에 들어갑니다. 예 :

function foo(bar) { 
/// <summary>a function called foo</summary> 
/// <param name="bar"> a param called bar </param> 
/// <returns type="Boolean">Boolean value of bar </returns> 
return !!bar; 
} 
1

YUIDoc을 확인할 수 있습니다. 그것은 우리가 모든 프로젝트에서 사용하는 것이며 최종 출력은 http://yuilibrary.com/yui/docs/api/classes/Anim.html입니다. 물론 모양은 사용자 자신의 템플릿, 사용자 정의 CSS 등으로 완전히 사용자 정의 할 수 있으므로 전혀 다른 모양을 만들 수 있습니다.

+0

불행히도 sandlastle 구문은 사용하지 않습니다. 적어도 http://yui.github.io/yuidoc/에 따르지 않아야합니다. –