Metalama icon indicating copy to clipboard operation
Metalama copied to clipboard

Feature request: introduce XML comments

Open WhitWaldo opened this issue 1 year ago • 4 comments

Especially as Metalama is capable of producing whole new properties, fields and methods to classes (and in the future hopefully, whole classes as well) and since the output can be consumed by other developers, it'd be ideal if there were some mechanism by which any of these introduced elements could also include comments passed through during compilation.

Especially on templates, it'd be great if I could just document the template itself and that carry through, but it'd be great if there were a programmatic means of doing so as well (e.g. when looping through a collection of types where it wouldn't make sense to put the same <see cref=""/> tags in the documentation).

Thank you for the consideration!

WhitWaldo avatar May 04 '23 07:05 WhitWaldo

Hello @WhitWaldo, thank you for submitting this issue. We will try to get back to you as soon as possible. Note to the PostSharp team, this ticket is being tracked in our dashboard under ID TP-33072.

PostSharpBot avatar May 04 '23 07:05 PostSharpBot

Thank you for the feedback. It's would be a good feature but a complex one. Let's keep that open for the future.

gfraiteur avatar May 04 '23 08:05 gfraiteur

I'd like to augment this request. Just as compile-time parameters aren't included in the signature of the method after the aspect is run, I'd like to similarly be able to write my XML comments on top of a templated method and include params and typeparams in the comments (for my benefit at design time for the aspect), but ensure that these lines of documentation that relate to [CompileTime] parameters aren't included in the output comments.

WhitWaldo avatar Jul 21 '23 02:07 WhitWaldo

I like this feature as well :)

PeterHevesi avatar Jul 27 '23 07:07 PeterHevesi