Missing documentation for CSharp code generator
See original GitHub issueThe documentation for the CSharp generator seems to be missing some comments that would be nice to see.
#288- #289
<remarks>
comments- Able to specify
<exception>
comments such as the AutoRest validation exception. Prefix ‘gets or sets’ in the comments based on the properties settings such as isReadOnly
- We’ve noticed that the other teams have ‘gets or sets’ in their descriptions for definitions since the ‘gets or sets’ comment is not being set in the model template. This will be an issue when they are generating other clients. Since the comment will not make any sense in the python client for example.
I have a fix for 5, found where the ‘get or sets’ prefix is generated in the model template and added this check.
@:/// <summary> @:@WrapComment("/// ", property.IsReadOnly ? "Gets " + property.Documentation.EscapeXmlComment() : "Gets or sets " + property.Documentation.EscapeXmlComment()) @:/// </summary>
Issue Analytics
- State:
- Created 7 years ago
- Comments:11 (11 by maintainers)
Top Results From Across the Web
Introducing C# Source Generators - .NET Blog
We'd love to learn more about how you think Source Generators could improve your code, and what you feel is missing or needs...
Read more >Source Generators Not Generating Sources #49249
I am having trouble getting the source generators to run/work. I am not sure what is not working. I have been working on...
Read more >Can I get a report on missing XML documentation
I am trying out GhostDoc, StyleCop, CodeIt.Right, FXCop etc to find a streamlined way of adding both autogenerated XML-Comments in C# code as ......
Read more >C# and XML Source Code Documentation
Demonstrates how to use C#.NET's XML source documentation to produce professional, indexed, and searchable source documentation.
Read more >C# Generated Code | Protocol Buffers
You should read the proto3 language guide before reading this document. ... Only proto3 messages are supported by the C# code generator.
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
@tbombach @markcowl @hovsepm @brjohnstmsft I am working on solving number 3 above.
Are you okay with the following? On operations:
"summary"
maps to<summary>
(it already does this actually, just including it for completeness)On models:
"title"
maps to<summary>
, and if"title"
is not specified, then"description"
gets promoted to<summary>
instead, to avoid breaking existing client documentation patterns which have"description"
being used as the<summary>
tag everywhere.@fearthecowboy – Long time coming but just wanted to confirm that you do indeed output the exception details now. Thanks!
It looks like the only remaining issue here is 2, which is also being tracked here: #289, so I think you can close this issue now.