Compodoc 文档覆盖范围声明编号含义（1/3、1/2 等...）答案

【问题标题】：Compodoc Documentation Coverage Statement Numbers Meaning (1/3, 1/2, etc...)Compodoc 文档覆盖范围声明编号含义（1/3、1/2 等...）
【发布时间】：2019-11-14 17:29:46
【问题描述】：

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

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

/**
 * 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 是什么？如何确定组件、注射剂等需要哪些文档？？？

【问题讨论】：

标签： angular documentation compodoc

【解决方案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

【讨论】：

谢谢。这帮助很大。