ExpressionToCode icon indicating copy to clipboard operation
ExpressionToCode copied to clipboard

Published 20 hours ago • verified publisher icon EamonNerbonne

Nuget should include documentation

Open dzmitry-lahoda opened this issue 6 years ago • 4 comments

Add XML comments along with dll.

dzmitry-lahoda avatar Feb 16 '18 09:02 dzmitry-lahoda

I'll enable the xml comments I already have embedded anyhow; however I also have a bunch of overloads and places where public stuff is perhaps not fully documented.

Do you have experience with using these doccomments in nuget packages?

Any pointers, PRs, suggestions, or places where docs are particularly relevant would be much appreciated.

EamonNerbonne avatar Feb 16 '18 13:02 EamonNerbonne

Pushed as 2.6.0

EamonNerbonne avatar Feb 16 '18 13:02 EamonNerbonne

You may look into FastExpressionCompiler. When I nuget it I get xml along side with dll. This XML is consumed by VS IDE and I see comments during typing. Just include that XML into nuget, most nugets do it. Thanks.

dzmitry-lahoda avatar Feb 16 '18 13:02 dzmitry-lahoda

Yeah, I'm using <GenerateDocumentationFile>true</GenerateDocumentationFile> too in 2.6.0 now; I just don't really feel like copy-pasting the same comment 10 times across all kinds of overloads, and then maintaining all that.

I'll see. Kind of hoping there was some simpler solution/

EamonNerbonne avatar Feb 16 '18 14:02 EamonNerbonne