mirror of
https://github.com/adamhathcock/sharpcompress.git
synced 2026-02-03 21:23:38 +00:00
Enable "XML documentation file" in the SharpCompress project to enable Intellisense tooltips for users of the SharpCompress library #59
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @elgonzo on GitHub (Sep 4, 2015).
I noticed in the SharpCompress.csproj project file, that the build setting "XML document file" is not set.
Enabling this setting and set the XML file name to the same as the library (i.e., "SharpCompress.xml") will generate a XML documentation file usable by Intellisense. Put it together with the library in the nuget package, and the users of the SharpCompress library will be able to see Intellisense tooltips with the method/field/class/etc. documentation comments you have already written in the source code...
(I am aware that not all public members of the SharpCompress classes have documentation comments. But many already have. And it would be a shame to not make them available through Intellisense...)