egordorichev / LastTry

:deciduous_tree: LastTry is open-source game written in Java, using LibGDX library and inspired by Terraria :deciduous_tree:
MIT License
119 stars 17 forks source link

Java doc and java code style #30

Closed egordorichev closed 7 years ago

egordorichev commented 7 years ago

@Col-E, I see, that my java doc style is not perfect (in fact, it is first time I use it a lot). So can you figure out the code style and java doc style for the project. Is this a good style?

        /**
     * Handles window resize
     * @param width new window width
     * @param height new window height
     */
    @Override
    public void resize(int width, int height) {
        super.resize(width, height);

        viewport.update(width, height);
        camera.update();
    }
Col-E commented 7 years ago

All you really need to do for javadoc is just follow oracle's post. You don't have to be super verbose like some of the examples it gives since this is still a WIP and things can change fairly often, but aside from that it's spot on.

When the project is more flushed out then the javadocs can be spiced up and become more verbose like the examples from the post.