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 formatter.xml for contributors #26

Open
dector opened this issue Sep 12, 2013 · 4 comments
Open

Add formatter.xml for contributors #26

dector opened this issue Sep 12, 2013 · 4 comments

Comments

@dector
Copy link

dector commented Sep 12, 2013

Hello. Wanna ask why this source code isn't using Sun code conventions? I assume, that it's because your main language is ActionScript?
And is there any internal conventions for code contributing?

Thank you.

@WingEraser
Copy link
Member

I edited the title otherwise it looks like a question for the forums. The reason why the code is this way is because the most code is ported from the original flixel. There are some code like the underscore for private variables and capital for the arguments (I don’t use this one). I haven’t use Sun’s conventions, because at work they use their own conventions.

Having an eclipse-formatter.xml for flixel-gdx would be handy for contributors.

@dector
Copy link
Author

dector commented Sep 13, 2013

I think, formatter.xml file isn't necessary. As for me, I don't use auto-formatting.
Just need few lines about naming for: private, public, static variables, method parameters, classes and so on.
But the common way is to use "default" conventions: http://www.oracle.com/technetwork/java/codeconventions-150003.pdf

@WingEraser
Copy link
Member

There is Java Conventions formatter in eclipse. You can copy that and adjust it. The main difference in flixel is that the begin bracket is placed at left. I need to check the other differences, but you’re free to use that.

@WingEraser
Copy link
Member

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

No branches or pull requests

2 participants