如果代码未在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编译器实际上并不关心JSDoc注释，除非它试图理解JavaScript文件 - 所以您需要添加TSLint。

TSLint可以被配置为检查很多额外的东西，编译器不关心，有一个ruleset for TSLint with JSDoc.

说了这么多，最好的TSLint规则集适中规则集。