dotnet / dotnet/docfx

[Feature request] Provide doc comment coverage metrics for code coverage tools

Open
#7,059 0 comments 0 reactions 0 assignees View on GitHub
dotnet
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

It would be nice if DocFX could generate a "coverage" report, or some form of structured metadata output that could be used by other coverage tools, e.g. Resharper, OpenCover, NCover. This report or data would provide summary stats of the percentage of accessible code covered by documentation comments in the code, or by entries in separate documentation files, in a form similar to test coverage data.

Options could eventually include:

- whether to include `internal`, `protected`, or `private` entities, perhaps using only `public` by default;
- detecting and reporting where repeated doc strings could be replaced with `/// ` (although, perhaps that is a [StyleCop Analyzer](https://github.com/DotNetAnalyzers/StyleCopAnalyzers) feature); and
- quality indicators, e.g. whether the documentation comments are complete, incomplete, missing `` tags, present but empty, and so on.

Forgive me if this data is provided somewhere already, but I can't seem to find it anywhere.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.