Compodoc文档覆盖范围声明编号含义(1/3、1/2等)

Question

我正在为Angular应用程序使用compodoc，并使用文档覆盖率来确保我对应用程序进行了完整的文档记录。当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是什么？我如何确定组件、注射剂等需要什么文档？？？

Answer 1

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

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

• 类本身(就像您所做的那样(
• 公共方法(包括constructor和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