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
Support for doc comments on same line. #12803
Comments
Added Area-DartDoc, Triaged labels. |
Added old-dartdoc label. |
Removed Priority-Unassigned, old-dartdoc labels. |
Removed Type-Defect label. |
Added Pkg-DartDoc label. |
Removed Area-DartDoc label. |
Removed Pkg-DartDoc label. |
Thanks for the suggestion! We looked at the spec, and the spec defines how to connect a doc comment and the thing it's describing. If you're like to pursue this, it would take a spec change. I'm reclassifying this request as a Language request. Removed Area-Pkg, Pkg-DocGen labels. |
I don't think the spec should be in the business of defining doc comments. How about we remove that from the spec and then kick this over to dartdoc? |
This isn't something we've had continued demand for. Doc comments which are short enough to fit on the same are unlikely to add new information over the type and name so I'd think most of them can be omitted anyway. Is there value in keeping this open? |
My vote: close |
Closing. If there is renewed interest in this proposal please add a comment and we can reopen. |
This issue was originally filed by pixe...@gmail.com
Hi, Would be nice to be able to document code like this:
class MyClass {
int id; /// Doc comment for id
String name; /// Doc comment for name
String description; /// Doc comment for description
String otherValue; /// Doc comment for otherValue
}
Instead of:
class MyClass {
/// Doc comment for id
int id;
/// Doc comment for name
String name;
/// Doc comment for description
String description;
/// Doc comment for otherValue
String otherValue;
}
The text was updated successfully, but these errors were encountered: