-
Notifications
You must be signed in to change notification settings - Fork 73
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
[Feature] Comment doc block #237
Comments
i think we should use also we should think through tags like this: /**
@return It will return none if has failed
*/
async fn get_user() -> Option<User> { ... } |
id say we go with these:
|
Seems the best way, maybe with https://docs.rs/comment-parser/latest/comment_parser/ we can implement easily? |
At #62 I used |
So we want follow the jsdoc standard or one c style? |
Oh yeah we could add the |
If we will go on So in the way I will add all the comments in the stdlib |
So right now we have tons of function in stdlib.
Can be handy to document them in the file itself, in this way the documentation can generated aautomatically.
So I was thinking something for that.
In Amber looking at the doc there is no way right now for commenting, so we need to choose what is the best way.
Rust uses
/**
like PHP (https://doc.rust-lang.org/reference/comments.html), python instead use"""the sentence"""
.The text was updated successfully, but these errors were encountered: