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

We should not be using camel casing rules in comments/javadocs when referring to acronyms #903

Closed
martinsawicki opened this issue Jun 26, 2016 · 2 comments
Milestone

Comments

@martinsawicki
Copy link

A comment or Javadoc is just English text, so the acronym naming recommendations that otherwise apply to code (Dns instead of DNS, etc) should not be followed there.
Instead it should be just the way it is named: DNS, ID, FQDN, IP, MAC, etc.
It'd be good to do a scrub across the board.

@martinsawicki
Copy link
Author

fixed in beta2 with global replace in PR: #901

It'd be good to have some sort of a checkstyle rule though -- looking for these patterns in comments and Javadocs (case sensitive) " Ip ", " Dns ", " Fqdn " at least.

@jianghaolu
Copy link
Contributor

This will be overwritten by auto-generation if we auto-generate the interfaces. The correct solution is to fix in Swagger specs.

@github-actions github-actions bot locked and limited conversation to collaborators Apr 13, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants