https://github.com/artees/doccover

A .NET Core application that calculates the percentage of public members and types in your .NET assembly that have XML comments.
https://github.com/artees/doccover

comments documentation xml

Last synced: 10 months ago
JSON representation

A .NET Core application that calculates the percentage of public members and types in your .NET assembly that have XML comments.

• Host: GitHub
• URL: https://github.com/artees/doccover
• Owner: Artees
• License: mit
• Created: 2018-08-11T22:55:46.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-09-01T20:21:27.000Z (almost 8 years ago)
• Last Synced: 2024-04-29T17:08:02.128Z (about 2 years ago)
• Topics: comments, documentation, xml
• Language: C#
• Homepage:
• Size: 31.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# DocCover

[![GitHub release](https://img.shields.io/github/release/Artees/DocCover.svg)](https://github.com/Artees/DocCover/releases)

[![NuGet](https://img.shields.io/nuget/v/DocCover.svg)](https://www.nuget.org/packages/DocCover/)

    

[![Build Status](https://travis-ci.org/Artees/DocCover.svg?branch=master)](https://travis-ci.org/Artees/DocCover)

[![codecov](https://codecov.io/gh/Artees/DocCover/branch/master/graph/badge.svg)](https://codecov.io/gh/Artees/DocCover)

[![CodeFactor](https://www.codefactor.io/repository/github/artees/doccover/badge)](https://www.codefactor.io/repository/github/artees/doccover)

A .NET Core application that calculates the percentage of public members and types in your 

.NET assembly that have XML comments. I just wanted this badge for my repos :3 

[![Documented](report_example/badge.svg)](https://htmlpreview.github.io/?https://github.com/Artees/DocCover/blob/master/report_example/index.html)  

It uses [Shields.io](https://shields.io) to generate a badge.

## Usage

`dotnet path\to\DocCover.dll path\to\docs.xml`

Command line arguments:

| Argument                  	| Description                                                                                                                                     	|

|---------------------------	|-------------------------------------------------------------------------------------------------------------------------------------------------	|

| --help                    	| Display the help screen.                                                                                                                        	|

| --version                 	| Display version information.                                                                                                                    	|

| -x, --xml (pos. 0)        	| The XML document to be analyzed.                                                                                                                	|

| -d, --dll (pos. 1)        	| The assembly file to be analyzed. If not specified, the path of the XML document will be used.                                                  	|

| -o, --outputdir (pos. 2)  	| The directory where the generated report should be saved.                                                                                       	|

| -s, --badgestyle (pos. 3) 	| The style of the generated badge. The following styles are available: plastic, flat, flat-square, for-the-badge, popout, popout-square, social. 	|