Help - line wrap #833
Comments
Unless I'm missing something, but it's not as simple as that. You might have a summary that spans multiple lines (for code readability) but you really want the newlines removed in the help description, e.g.: /// <summary>
/// This is a really long summary because my app is really great and I want
/// to say lots of great things about it in this summary so people will use it
/// all the time and then I will get famous.
/// </Summary> So how do you to tell DragonFruit that it should keep the newline? You could use a special character e.g. /// <summary>
/// - This is a really great app
/// - You can use it for all the things
/// </Summary> But then you should support multiple levels of indentation, bullet points and so forth? Is this really worth it? For instance, |
I don't think it needs to be complicated. just look for a newline? I don't think there is any need for detailed formatting in comments but I do see the need for line returns |
But the newline won't work in every case - if you have a long Summary and have used newlines for code readability, you want these removed in the help command. |
.NET XML documentation supports the https://docs.microsoft.com/dotnet/csharp/programming-guide/xmldoc/para |
tags do not create newlines in --help from dragon fruit. That would be great if they did! |
I ran the test, and saw that if there was only one para tag it did create the new line? But multiple it didn't, because it uses Value? I do think proper handling of doc string tags (list, para, etc) would help create nice help messages, which are nice to have. |
In my code I have a multiple line summary (comments) for my main method.
when I run my executable and ask for help myapp.exe --help the summary gets line wrapped.
I would like for each line in my summary to have a new line between.
I have tried every mechanism to make this work to no joy (also looked in the dragonfruit code a little) but couldn't find a quick fix.
The text was updated successfully, but these errors were encountered: