dawedawe / fsih

MIT License
34 stars 0 forks source link

support reading standard F# public summary comments /// #7

Open jkone27 opened 8 months ago

jkone27 commented 8 months ago
image

i believe in F# /// should generate standard xml summary block comments in the compiled code, is that right?

image

xmlDoc = PreXmlDoc.Create([| "/// test summary" |], R("(1,0--1,16)")),

example from fantomas tool

https://fsprojects.github.io/fantomas-tools/#/ast?data=N4KABGBEAmCmBmBLAdrAzpAXFSAacUiaAYmolmPAIYA2as%2BEkAxgPZwWQD0PYALuj5g0AVwC2YqgCcAngB1kNWEIAeYALxgArArwFIsFQAcqyaBT5SRsEAF8gA

example "usage" / "h" result

image
dawedawe commented 8 months ago

Hey @jkone27, thanks for this interesting use case. As it's pretty different from the usual "read the documentation from the xml file", I'll need to do some research to see if there's a way for us to get our hands on the comment content when we are inside of FSI.

jkone27 commented 3 months ago

this could be very useful for internal documentation potentially, but also for any public available xml comments in nuget .NET libs? in F# /// creates valid xml compliant .NET comments if i remember correctly