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.

Sign up for GitHub

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

Jump to bottom

Make <summary> optional in XML doc comments #3637

Closed
lostmsu opened this issue Jul 2, 2020 · 3 comments
Closed

Make <summary> optional in XML doc comments #3637

lostmsu opened this issue Jul 2, 2020 · 3 comments

Comments

@lostmsu
Copy link

lostmsu commented Jul 2, 2020 •
edited
Loading

These make writing documentation in a nicer way in F#: F# single-line xmldoc.

The proposal is to treat

/// This is a great function,
/// that does good
void DoGood() => ...;

the same way as

/// <summary>This is a great function, that does good</summary>
void DoGood() => ...;
@jnm2
Copy link
Contributor

jnm2 commented Jul 3, 2020 •
edited
Loading

This would be a consequence of this existing issue: #2394
Related: #878, #891

@lostmsu lostmsu changed the title Single line summary comments Make <summary> optional in XML doc comments Jul 3, 2020
@sharwell
Copy link
Member

sharwell commented Jul 7, 2020

Duplicate of #2394

@YairHalberstadt
Copy link
Contributor

Closing as duplicate of #2394

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@lostmsu @sharwell @jnm2 @YairHalberstadt