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);
  }

是否可以在TypeScript和Angular 4中执行此操作？

Answer 1

TypeScript编译器实际上并不关心JSDoc注释，除非它试图理解JavaScript文件 - 所以你需要添加TSLint。

TSLint可以配置为检查编译器不关心的大量额外内容，有ruleset for TSLint with JSDoc.

说完这一切之后，最好的TSLint规则集是适度的规则集。

如果在TypeScript中没有记录代码，则打破构建

1 个答案: