Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 1.39 KB

README.md

File metadata and controls

33 lines (24 loc) · 1.39 KB

CommentStripper

Removes XML comments in the XML doc file, for non-public members using the compiled dll.

Current status Build status

By adding this package to your project, any private XML doc comments (three slashes - /// ) will be removed from the generated XML doc file. This will not add anything to the project output, you can verify that the nuget is a developmentDependency, it runs an executable as a post build step.

Usage

Run:

Install-Package CommentStripper

or run:

dotnet add package CommentStripper

or add:

<PackageReference Include="CommentStripper" Version="0.0.1">
    <PrivateAssets>all</PrivateAssets>
    <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>

Sample

Code that looks like: xml documented code generating xml doc with private member comments

Will no longer have the comments from the private members xml doc without the private member comments