我正在为Angular应用程序使用compodoc,并使用文档覆盖范围来确保我已完全记录了该应用程序。当Statement值为0/3或1/2时,如何确定代码/文件中/ ** ...注释中缺少哪些文档?
示例-对于我的用户组件,我的评论是:
library("ggplot2")
ggplot(carData::GSSvocab,
aes(x = age,
y = educ)) +
geom_jitter(alpha = 0.1)
该文件的文档覆盖率声明指出(33%1/3)。缺少的2/3是多少?如何确定组件,注射剂等所需的文档?
答案 0 :(得分: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