Parameter comments in method XML documentation

[jpseini]

Ask a question

Related to #47 - when generating c# code from a ClassModel created in the Domain Designer, is there a way to add operation parameter comments to the operation XML documentation?

I am adding XML comments using:

method.TryAddXmlDocComments(operation.InternalElement);

which adds the operation comments correctly and successfully, but not any operation parameter comments

Designer:

Generated code:

1. Is there currently a way to achieve this?
2. If not, is there a suggested way to handle Intent ignore any XML documentation comments added by the user (if for example, Intent generated only the class structure, and the user documented it manually)

Thanks.

[joelsteventurner]

Hi @jpseini

I've logged this as an improvement on our product backlog. I'll keep you posted on when this is available.

As for getting Intent to Ignore Comments you can do something like this.

Hopefully this helps you out for now, if not let me know and I'll see what else I can do.

[jpseini]

Thanks @joelsteventurner. The code snippet above will definitely work for me for now - thanks for it.

[joelsteventurner]

Hi @jpseini

Just to let you know we have a pre-release out with this feature, i.e. Operation parameter comments added to the XmlDocComments. You would need to update the following modules.

Intent.Common.CSharp - v3.3.39-pre.4 Intent.Application.Contracts - v5.0.2-pre.0 Intent.Application.ServiceImplementations - 4.3.1-pre.0

Let me know if you have any questions or issues.