-
Notifications
You must be signed in to change notification settings - Fork 32
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
Which code conventions to use? #126
Comments
Hmm... use JavaDoc. I'm trying to remember why I even wrote the style guide in the first place since I ended up using JavaDoc 90% of the time anyways. Sorry for the confusion. |
I'll leave this open until the spec file is removed and the README is updated. |
OK, thanks for clarification. What about whitespace and curly brackets? Should I use the default "Java" style private int something() { doSomething(); } or follow the style guide, i.e. private int something() { doSomething(); } |
Java style. 👍🏼 |
Which code conventions to use?
I want to improve the code base quality a bit and have noticed that the conventions used are somewhat inconsistent. Sometimes the project style conventions are used but often the standard Java ones are used as well, especially when it comes to whitespace and the position of curly brackets. Which code conventions are to be used?
Also, which doc comments are preferred? The ones in SourceStyleGuide.md or JavaDoc?
The text was updated successfully, but these errors were encountered: