dgeni를 사용하여 typescript 파일의 문서 주석을 구문 분석하는 방법

Question

기존의 javascript 파일에서 markdown 문서를 추출하려면 dgeni을 설정해야합니다. typescript 파일을 구문 분석하기 위해이 파일을 확장하려고합니다.

error: Error processing docs: Error: No file reader found for javascript/components/main.ts 
    at matchFileReader (node_modules\dgeni-packages\base\processors\read-files.js:130:25) 
    at node_modules\dgeni-packages\base\processors\read-files.js:66:99 
    at <anonymous> 

내가 dgeni-packages:3e07adee84b7a795a0fb02d7181effa593fb9b4f 같은 몇 가지 커밋을 발견하고 나는 다시 검색하고 및 검색 설정하는 방법 dgeni을하기 :

는 그냥 소스 파일에이 문제를 해결할 것 포함에 .ts 파일을 추가하지만 약간의 오차가 발생합니다 생각했다. 도 타이프 라이터 파일을 구문 분석 dgeni 얻을 수있는 쉬운 방법이 있나요

'use strict'; 

const path = require('canonical-path'); 
const {Dgeni, Package} = require('dgeni'); 

const docs= new Package('docs', [ 
    require('dgeni-markdown') 
]) 
    .processor(require('./indexPage')) 
    .config(function (log, readFilesProcessor, writeFilesProcessor, templateFinder, apiPagesProcessor) { 
    log.level = 'warn'; 
    readFilesProcessor.basePath = path.resolve(__dirname, '..'); 
    readFilesProcessor.sourceFiles = [ 
     { 
     include: 'src/main/javascript/**/*.js', 
     basePath: 'src/main/javascript' 
     }, 
    ]; 
    templateFinder.templateFolders.unshift(path.resolve(__dirname, 'templates')); 
    apiPagesProcessor.pathFromOutputToRootFolder = '../..'; 
    writeFilesProcessor.outputFolder = 'docs/generated'; 
    }); 
const dgeni = new Dgeni([docs]); 

module.exports =() => dgeni.generate().then(done); 

dgeni.generate().then(done); 

function done() { 
    console.log('Generated documentation.'); 
} 

:

우리는 우리의 문서를 생성? 그냥 같은 코멘트 :

/** 
* @ngdoc directive 
* @module we.components 
* @name contactSlideout 
* @restrict E 
* 
* @description 
* Contact Slideout. 
* 
*/ 

Answer 1

나는 dgeni-markdown 전에 dgeni-packages/typescript 패키지를 추가 readTypeScriptModules을 구성 설명서를 수출 바로 위에 확인했다.

const docs = new Package('docs', [ 
    require('dgeni-packages/typescript'), 
    require('dgeni-markdown') 
]) 
.config(function (readTypeScriptModules) { 
    readTypeScriptModules.basePath = path.resolve(__dirname, '..'); 
    readTypeScriptModules.sourceFiles = [ 
    { 
     include: 'src/main/javascript/**/*.ts', 
     basePath: 'src/main/javascript' 
    }]; 
}); 

문서가 내보내기 바로 위에 있는지 확인하십시오.

/** 
* @ngdoc directive 
* @module we.components 
* @name contactSlideout 
* @restrict E 
* 
* @description 
* Der Tooltip-Teil vom Contact-Menü. Zu verwenden zusammen mit hmContactSlideout. 
* 
*/ 
export default module.component('contactSlideout', { 

이 추가 타이프 라이터 지원 커밋 : 깊이 파고해야하는 사람을위한 3e07adee8을.