search

postsharp / Metalama

Metalama is a Roslyn-based meta-programming framework. Use this repo to report bugs or ask questions.
181 stars 6 forks source link

Feature request: Introduce XML doc (///) comments on generated code #357

Closed niklasstich closed 2 months ago

niklasstich commented 3 months ago

For various reasons, we might have to give users documentation on our generated aspect code sometimes, especially when said code is intended to be called from user code. This might be usage instructions, explanations of parameters, documentation of all possible exceptions or other remarks, and it is not sufficient to simply document all this information on the aspect attribute itself. For that reason, it should be a feature to introduce XML doc above IDeclarations (types, interfaces, methods, properties, fields) that we introduced programmatically via builder or builder.Advice.

It would probably be easiest to just take in a string and put it verbatim on the declaration instead of having some sort of "XmlDocBuilder" that implements all the various XML doc tags.

niklasstich commented 3 months ago

I see the spam bots have finally arrived on GitHub too...

prochan2 commented 3 months ago

I see the spam bots have finally arrived on GitHub too...

Reported.

gfraiteur commented 2 months ago

This is a duplicate of #113.