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.

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

Add more detail comments for each field #14

Open
haorenfsa opened this issue May 14, 2022 · 0 comments
Open

Add more detail comments for each field #14

haorenfsa opened this issue May 14, 2022 · 0 comments

Comments

@haorenfsa
Copy link

The compiler will compile the comments into the target languages.
Take golang as example, the godoc is generated by comments. This will make it look prettier.

I'm writing the documents for RESTful APIs. And I'm using swagger for document generation.
Swagger generates field description by golang comment as well. So more comments would helps a lot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant