RequireJS 및 JSDoc3을 사용하여 마리오 네트 모듈 문서화

Question

마지막으로 마리오네트 코드를 공식적으로 문서화하는 데 시간이 좀 걸리지 만 JSDoc3 및 마리오네트 모듈과 관련된 문제가 있습니다.

I는 다음과 같이 정의 된 마리오네트 모듈 문서화 가겠어요 방법 :

//views.js 
define([...], function(...){ 
    "usestrict"; 

    var itemView = Marionette.ItemView.extend({ 
     ... 
    }; 

    //Uses itemView in a region 
    return Marionette.Layout.extend({ 
     ... 
     //do stuff with itemView 
     ... 
    }); 
} 

: 다음과 같이 정의 된보기로

//Module1.js 
define([... , 'views'], function(..., 'views'){ 
    "usestrict"; 

    //Marionette Module definition: 
    return function(...marionette module params...){ 
     ... 
    } 
} 

을 한 후 문서에를 연결?

감사합니다.

Answer 1

좋아, 루이 덕분에 모듈을 인식하는 방법을 알았습니다. 그런 다음 뷰를 모듈에 클래스로 등록 할 수있을만큼 충분히 뒤죽박죽으로 사용할 수있었습니다.

Module1.js :

/** @module Module1 */ 
define([... , 'views'], function(..., 'views'){ 
    "usestrict"; 

    /** @lends module:Module1 */ 

    //Marionette Module definition: 
    return function(...marionette module params...){ 
     ... 
    } 
} 

및 View.js :

define([...], function(...){ 
    "usestrict"; 

    /** 
    * @name module:Module1.Module1/Views/itemView 
    * @constructor 
    */ 
    var itemView = Marionette.ItemView.extend(
    /** @lends module:Module1.Module1/Views/itemView.prototype */ 
    { 
     ... 
    }; 

    /** 
    * @name module:Module1.Module1/Views/layoutView 
    * @constructor 
    */ 
    return Marionette.Layout.extend(
    /** @lends module:Module1.Module1/Views/layoutView.prototype */ 
    { 
     ... 
     //do stuff with itemView 
     ... 
    }); 
} 

노트의 몇 : 뷰에 대한 @name에서

• 의 .Module1/필요한 것은 아니지만 doc 웹 페이지에서 쉽게 찾을 수 있습니다.
• The i temView는 반환되지 않기 때문에이 예제에서는 비공개입니다.하지만 문서에서 찾을 수 있기를 원합니다.