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

Which code conventions to use? #126

Open
tzuntar opened this issue Sep 7, 2019 · 4 comments
Open

Which code conventions to use? #126

tzuntar opened this issue Sep 7, 2019 · 4 comments

Comments

@tzuntar
Copy link

tzuntar commented Sep 7, 2019

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?

@Sergix
Copy link
Owner

Sergix commented Sep 7, 2019

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.

@Sergix
Copy link
Owner

Sergix commented Sep 7, 2019

I'll leave this open until the spec file is removed and the README is updated.

@tzuntar
Copy link
Author

tzuntar commented Sep 7, 2019

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();
}

@Sergix
Copy link
Owner

Sergix commented Sep 7, 2019

Java style. 👍🏼

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

2 participants