{"id":37036390,"url":"https://github.com/p1va/dotnet-document","last_synced_at":"2026-01-14T04:19:40.634Z","repository":{"id":39923088,"uuid":"325614898","full_name":"p1va/dotnet-document","owner":"p1va","description":"A tool for auto-generating XML documentation for your C# code","archived":false,"fork":false,"pushed_at":"2025-06-05T09:35:09.000Z","size":315,"stargazers_count":106,"open_issues_count":15,"forks_count":19,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-10-18T01:26:59.250Z","etag":null,"topics":["csharp","documentation","documentation-generator","dotnet-core","dotnet-tool"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/p1va.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-12-30T17:56:58.000Z","updated_at":"2025-08-27T12:25:49.000Z","dependencies_parsed_at":"2025-05-16T10:15:24.233Z","dependency_job_id":null,"html_url":"https://github.com/p1va/dotnet-document","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/p1va/dotnet-document","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/p1va%2Fdotnet-document","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/p1va%2Fdotnet-document/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/p1va%2Fdotnet-document/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/p1va%2Fdotnet-document/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/p1va","download_url":"https://codeload.github.com/p1va/dotnet-document/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/p1va%2Fdotnet-document/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28409357,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T01:52:23.358Z","status":"online","status_checked_at":"2026-01-14T02:00:06.678Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csharp","documentation","documentation-generator","dotnet-core","dotnet-tool"],"created_at":"2026-01-14T04:19:40.055Z","updated_at":"2026-01-14T04:19:40.626Z","avatar_url":"https://github.com/p1va.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"art/dotnet-document.png\"/\u003e\n\u003c/p\u003e\n\n# dotnet-document\n\n![Build](https://github.com/p1va/dotnet-document/workflows/Build/badge.svg)\n[![NuGet](https://img.shields.io/nuget/v/dotnet-document.svg)](https://www.nuget.org/packages/dotnet-document) \n[![NuGet](https://img.shields.io/nuget/dt/dotnet-document.svg)](https://www.nuget.org/packages/dotnet-document)\n\n\nA cross platform tool that auto generates an XML doc starting point for your C# codebase.\n\nThanks to `Microsoft.CodeAnalysis.CSharp` this tool is able to identify undocumented members and to generate a meaningful XML doc by *humanizing* member names.\n\n| **Before** | **After** |\n|------------------------------------|---------------------------------|\n|\u003cimg src=\"art/without-comment.png\"/\u003e|\u003cimg src=\"art/with-comment.png\"/\u003e|\n\n## Installation\nThe tool can be installed globally via Nuget by running \n\n```sh\ndotnet tool install --global dotnet-document --version 0.1.9-alpha\n```\n\u003e 👉 When installing pre releases the version has to be explicitly specified\n\n## How to run\n\n### Apply doc\n\nTo run the tool invoke `dotnet document apply`\n\n```sh\n# Documents all *.cs files in the current dir and all sub dirs \ndotnet document apply\n\n# Documents the specified .cs file\ndotnet document apply ./src/folder/MyClass.cs\n\n# Documents all *.cs files in the specified dir and all sub dirs \ndotnet document apply ./src/folder/\n\n# Documents all *.cs files in the specified solution\ndotnet document apply ./src/solution.sln\n\n# Documents all *.cs files in the specified project\ndotnet document apply ./src/folder/project.csproj\n```\n\n### Dry run\nTo test the command without saving changes on disk a dry run option is available.\n\nIn case of undocumented members a non-zero exit code is returned so that it is possible to warn about it  during CI.\n```sh\ndotnet document apply --dry-run\n```\n## Configuration\n\nThe tool can be configured so that the generated XML documentation meets  the project guidelines.\n\n### Default configuration\n\nThe default configuration is used when no config file specified.\nIt can be viewed by invoking \n```sh\ndotnet document config --default\n```\n\n### Customizing configuration\n\nTo customize the configuration, simply save the default one somewhere and use your preferred editor to update it.\n\n```sh\ndotnet document config --default \u003e ~/my-dotnet-document.yaml\n```\n\nCustom 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.\n\n```sh\ndotnet document apply \\\n  -c ~/my-dotnet-document.yaml \\\n  ./src/folder/\n```\nTo double check which configuration is being used, invoke\n```sh\ndotnet document config\n```\n\n\u003e 👉 Folder based configuration discovery is not yet supported\n\n## Acknowledgments\n* [Humanizer](https://github.com/Humanizr/Humanizer) - Used for humanizing member names\n* [Ensure.That](https://github.com/danielwertheim/Ensure.That) - Used as a guard clause\n* [FluentAssertions](https://fluentassertions.com/) - Used for writing better assertions\n* [Moq4](https://github.com/Moq/moq4) - A mocking library for easier testing\n* [xUnit](https://github.com/xunit/xunit) - The test framework\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fp1va%2Fdotnet-document","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fp1va%2Fdotnet-document","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fp1va%2Fdotnet-document/lists"}