2

我正在将 compodoc 用于 Angular 应用程序并使用文档覆盖率来确保我完全记录了该应用程序。当 Statement 值为 0/3 或 1/2 时，如何确定代码/文件中的 /**... 注释中缺少哪些文档？

示例 - 对于我的用户组件，我的评论是：

/**
 * Users Component
 *
 * @export
 * @class UsersComponent
 * @implements {OnInit}
 */

@Component({
    selector: 'fcp-users',
    templateUrl: './users.component.html',
    styleUrls: ['./users.component.scss'],
})
export class UsersComponent implements OnInit {
    constructor() {}

    ngOnInit(): void {}
}

该文件的文档覆盖声明 (33% 1/3)。缺少的 2/3 是什么？我如何确定组件、注射剂等需要哪些文件？？？

4

1 回答 1

3

缺少的 2/3 似乎是您班级中的两种方法：constructor()和ngOnInit(). 如果您围绕这些添加文档，则该类的文档覆盖率应该达到 100%。

通常，您希望为您的类（包括服务、组件和任何其他类）记录以下内容：

  • 课程本身（就像你做的那样）
  • 公共方法（包括constructorand ngOnInit）
  • 公共财产

以下是一些带有文档的示例：

100% 覆盖率（9/9）：https ://compodoc.github.io/compodoc-demo-todomvc-angular/components/FooterComponent.html

83% 覆盖率（5/6）：https ://compodoc.github.io/compodoc-demo-todomvc-angular/components/HeaderComponent.html

于 2019-11-14T18:26:41.320 回答