https://github.com/p1va/dotnet-document
A tool for auto-generating XML documentation for your C# code
https://github.com/p1va/dotnet-document
csharp documentation documentation-generator dotnet-core dotnet-tool
Last synced: 5 months ago
JSON representation
A tool for auto-generating XML documentation for your C# code
- Host: GitHub
- URL: https://github.com/p1va/dotnet-document
- Owner: p1va
- License: mit
- Created: 2020-12-30T17:56:58.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-06-05T09:35:09.000Z (12 months ago)
- Last Synced: 2025-10-18T01:26:59.250Z (8 months ago)
- Topics: csharp, documentation, documentation-generator, dotnet-core, dotnet-tool
- Language: C#
- Homepage:
- Size: 308 KB
- Stars: 106
- Watchers: 5
- Forks: 19
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# dotnet-document
[](https://www.nuget.org/packages/dotnet-document)
[](https://www.nuget.org/packages/dotnet-document)
A cross platform tool that auto generates an XML doc starting point for your C# codebase.
Thanks to `Microsoft.CodeAnalysis.CSharp` this tool is able to identify undocumented members and to generate a meaningful XML doc by *humanizing* member names.
| **Before** | **After** |
|------------------------------------|---------------------------------|
|
|
|
## Installation
The tool can be installed globally via Nuget by running
```sh
dotnet tool install --global dotnet-document --version 0.1.9-alpha
```
> 👉 When installing pre releases the version has to be explicitly specified
## How to run
### Apply doc
To run the tool invoke `dotnet document apply`
```sh
# Documents all *.cs files in the current dir and all sub dirs
dotnet document apply
# Documents the specified .cs file
dotnet document apply ./src/folder/MyClass.cs
# Documents all *.cs files in the specified dir and all sub dirs
dotnet document apply ./src/folder/
# Documents all *.cs files in the specified solution
dotnet document apply ./src/solution.sln
# Documents all *.cs files in the specified project
dotnet document apply ./src/folder/project.csproj
```
### Dry run
To test the command without saving changes on disk a dry run option is available.
In case of undocumented members a non-zero exit code is returned so that it is possible to warn about it during CI.
```sh
dotnet document apply --dry-run
```
## Configuration
The tool can be configured so that the generated XML documentation meets the project guidelines.
### Default configuration
The default configuration is used when no config file specified.
It can be viewed by invoking
```sh
dotnet document config --default
```
### Customizing configuration
To customize the configuration, simply save the default one somewhere and use your preferred editor to update it.
```sh
dotnet document config --default > ~/my-dotnet-document.yaml
```
Custom configuration path can be provided either by setting a `DOTNET_DOCUMENT_CONFIG_FILE` env variable or by passing the `-c` argument when calling the `apply` command. The latter overrides the first.
```sh
dotnet document apply \
-c ~/my-dotnet-document.yaml \
./src/folder/
```
To double check which configuration is being used, invoke
```sh
dotnet document config
```
> 👉 Folder based configuration discovery is not yet supported
## Acknowledgments
* [Humanizer](https://github.com/Humanizr/Humanizer) - Used for humanizing member names
* [Ensure.That](https://github.com/danielwertheim/Ensure.That) - Used as a guard clause
* [FluentAssertions](https://fluentassertions.com/) - Used for writing better assertions
* [Moq4](https://github.com/Moq/moq4) - A mocking library for easier testing
* [xUnit](https://github.com/xunit/xunit) - The test framework