Angular Compodoc文件覆盖范围声明编号的含义(1/3、1/2等)
我将compodoc用于Angular应用程序,并使用文档覆盖率确保我对应用程序进行了完整的文档记录。当语句值为0/3或1/2时,如何确定/**。。。代码/文件中的注释 示例-对于我的用户组件,我的注释是:Angular Compodoc文件覆盖范围声明编号的含义(1/3、1/2等),angular,documentation,compodoc,Angular,Documentation,Compodoc,我将compodoc用于Angular应用程序,并使用文档覆盖率确保我对应用程序进行了完整的文档记录。当语句值为0/3或1/2时,如何确定/**。。。代码/文件中的注释 示例-对于我的用户组件,我的注释是: /** * Users Component * * @export * @class UsersComponent * @implements {OnInit} */ @Component({ selector: 'fcp-users', templateUrl
/**
* 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是什么?如何确定组件、可注入项等需要哪些文档?缺少的2/3似乎是类中的两个方法:
constructor()
和ngOnInit()
。如果您在这些方面添加文档,那么该类的文档覆盖率应该达到100%
通常,您希望为您的类(包括服务、组件和任何其他类)记录以下内容:
- 课程本身(就像你做的那样)
- 公共方法(包括
和构造函数
)ngOnInit
- 公共财产
83%的覆盖率(5/6):谢谢。这帮了大忙。