https://github.com/firesharkstudios/inheritdoc
Allows adding <inheritdoc/> tags to XML comments in C#
https://github.com/firesharkstudios/inheritdoc
comments csharp inheritdoc xml
Last synced: 6 months ago
JSON representation
Allows adding <inheritdoc/> tags to XML comments in C#
- Host: GitHub
- URL: https://github.com/firesharkstudios/inheritdoc
- Owner: firesharkstudios
- Created: 2017-12-20T02:07:06.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-10-11T20:49:38.000Z (over 2 years ago)
- Last Synced: 2023-02-28T09:32:07.581Z (over 2 years ago)
- Topics: comments, csharp, inheritdoc, xml
- Language: C#
- Homepage: https://www.inheritdoc.io
- Size: 121 KB
- Stars: 18
- Watchers: 3
- Forks: 17
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Allows adding `` tags to XML comments in C# source code to inherit XML comments from base classes, interfaces, and similar methods. **Eliminates** unwanted copying and pasting of duplicate XML comments and **automatically** keeps XML comments synchronized.
XML comments (starting with `///`) are compiled into XML documentation files for each assembly by the normal build process. **InheritDoc** post processes these XML documentation files to inherit XML comments as needed. This approach makes the XML comments **compatible** with other documentation tools, **accessible** by Intellisense, and **packagable** into a Nuget package if distributing a library.
This is the command line version (InheritDocLib contains the same functionality in .NET assembly for programmatic access).
See [www.inheritdoc.io](https://www.inheritdoc.io/) for more details.