Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request: introduce XML comments #113

Open
WhitWaldo opened this issue May 4, 2023 · 4 comments
Open

Feature request: introduce XML comments #113

WhitWaldo opened this issue May 4, 2023 · 4 comments
Labels
enhancement New feature or request

Comments

@WhitWaldo
Copy link

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!

@PostSharpBot
Copy link
Member

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.

@gfraiteur gfraiteur added the enhancement New feature or request label May 4, 2023
@gfraiteur gfraiteur changed the title Feature request: Enable comments to be bundled alongside an introduce template. Feature request: introduce XML comments May 4, 2023
@gfraiteur
Copy link
Member

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 gfraiteur added the later Will be addressed in a later release label May 4, 2023
@WhitWaldo
Copy link
Author

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.

@PeterHevesi
Copy link

I like this feature as well :)

@svick svick removed the later Will be addressed in a later release label Dec 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

5 participants