코드가 TypeScript에 문서화되지 않은 경우 빌드 빌드

Question

코드 설명서가 제공되지 않았거나 제대로 제공되지 않은 경우 빌드를 중단 할 수 있습니까?

예제 여기에는 문서가없는 메소드가 있습니다. 이 빌드는 방법은 여기 :

public onSuccessUpload(data: any) { 
    console.log(data); 
    } 

예를 문서화하지 않기 때문에 실패 할 필요를 위해 나는 방법 잘못된 문서를 가지고있다. 이 빌드는 방법은 문서화하지 않기 때문에 매개 변수 실패해야하는 경우 : 여기

/** 
* Executes when each file is uploaded successfully. 
*/ 
    public onSuccessUpload(data: any) { 
    console.log(data); 
    } 

예를 나는 방법 잘못된 문서를 가지고있다. 메소드가 매개 변수를 올바르게 문서화하지 않았기 때문에이 빌드를 실패해야합니다. string 다른 이름으로 문서 포인트 :

/** 
* Executes when each file is uploaded successfully. 
* @param {string} text Success Message. 
*/ 
    public onSuccessUpload(data: any) { 
    console.log(data); 
    } 

여기에 올바른 :

/** 
* Executes when each file is uploaded successfully. 
* @param {any} data response from file upload. 
*/ 
    public onSuccessUpload(data: any) { 
    console.log(data); 
    } 

는 타이프 4 각도에서이 작업을 수행 할 수 있습니까?

Answer 1

TypeScript 컴파일러는 JavaScript 파일을 이해하려고 할 때를 제외하고 JSDoc 주석을 실제로 신경 쓰지 않습니다. 따라서 TSLint를 추가해야합니다.

TSLint 컴파일러 걱정하지 않는 여분의 물건을 많이 확인하도록 구성 할 수 있습니다,이 모든 것을 갖는 ruleset for TSLint with JSDoc.

이, 최고의 TSLint의 규칙 세트는 적당한 규칙 세트입니다.