Compodoc 文档覆盖率声明数字含义（1/3、1/2 等...）

Question

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

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

/**
 * 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 似乎是您 class 中的两个方法：constructor() 和 ngOnInit()。如果您围绕这些添加文档，那么 class 的文档覆盖率应该达到 100%。

一般来说，您希望为您的 classes （包括服务、组件和任何其他 classes） 记录以下内容：

class 本身（就像你一样）
Public方法（包括constructor和ngOnInit）
Public属性

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

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

Compodoc 文档覆盖率声明数字含义（1/3、1/2 等...）

Compodoc Documentation Coverage Statement Numbers Meaning (1/3, 1/2, etc...)

documentation

angular

compodoc