2014-10-21 8 views
3

documentation for namepaths는 특수 문자를 이스케이프해야한다고 말했습니다 :jsDoc에서 이름/이벤트/콜백에 점을 어떻게 포함합니까?

위는 멤버 이름에 "이상한"문자 (해시 문자, 대시, 심지어 따옴표)와 네임 스페이스의 예입니다. 을 참조하려면 chat. "# channel", chat. "# channel". "op : announce-motd"등의 이름을 인용하면됩니다. .. "# 채널을" 채팅 "을 말한다 - \"

그러나,이 점에서 작동하지 않습니다 "\"안녕하세요 : 이름에 내부 따옴표는 백 슬래시로 이스케이프해야합니다. 문서화하려는 "cellClick.dt"이벤트가있을 경우 jsDoc은 출력에서 ​​문서를 건너 뛰고 목차에 잘못된 링크를 생성합니다. 나는 다음과 같은 조합을 시도했다 :

myClass~event.namespace 
'myClass~event.namespace' 
myClass~event\.namespace 
myclass~'event.namespace' 

그들 모두는 어떤 식 으로든 고장난 문서를 생성한다. 마지막으로 올바른 링크와 문서를 생성하는 것 같지만 아포스트로피는 여전히 출력에 있습니다. 따라서 이벤트에서 네임 스페이스 구분 기호로 점을 사용하는 코드를 문서화하는 것은 매우 번거로울 수 있습니다 (예 : jQuery 플러그인은 기본적으로 수행함).

어떻게해야할까요? 하나 있습니까? 내가 사용하는 버전은 3.3.0-alpha9입니다.

/** 
* @class 
*/ 
function myClass() { 
} 

/** 
* @memberof myClass 
* @event event.namespace 
*/ 

이벤트가 제대로 이름과 myClass의 회원입니다 :

답변

2

나는이 일을 건의 할 것입니다. 두 부분으로 전체 이름을 분리해야하는 것은 짜증나지만 적어도 결과는 추악하지 않습니다.

+0

나를 위해 작동하지 않았습니다. 생성 된 문서에는 주석이 표시되지 않았지만 네임 스페이스 부분이 TOC에있었습니다 (링크가 깨졌습니다). JSDoc 3.3.0-alpha9 –

+0

알파 버전을 사용하지 마십시오. 그것은 버기입니다. 내가 올바르게 기억한다면 최신 안정판은 3.2.2입니다. – Louis

+0

좋은 지적. 안정적으로 작동합니다. –