Test my simple SnakeGame

Question

hello everyone,
i'm a computer science student, i've been programming in java for a while and i'd like you to test my new release of the SnakeGame
this version is available on my web site : ( http://osminosm.olympe-network.com/?pid=5 ) in 3 forms : online (jnlp) , JAR and Java source code
i'm looking for tests, comments and modifications .
you're wellcome to contact me via the comment box provided in my website of e-mail me at : [email protected]
thank's in advance.
osman kalache

Answer 1

Hey there, I had a quick look at your app, and the source
I've a few points to make on your code commenting:
1. Your comments should never cover the how, and always cover the why - Code is being read by developers, and developers don't need to be reminded of how the language works
2. If you feel the need to add a comment, then you should consider renaming - Self documenting code is better than any number of comments - comments lie, because they are seldom updated when code is update.
3. Use Javadoc where appropriate (There is no need to put the method name above a method - the method name is there for everyone to see, and no amount of additional comments saying the name of the method is going to change that - however comments lie, and if the method name changes, the comment will be there for posterity making false claims)
4. If a comment deserves to exist, it deserves it's own line - In line comments (comments at the end of a line of code) should be avoided
On a general code note:
You should override the paintComponent method when you are extending Swing components
You shouldn't extend a class unless you are adding functionality, it is better to use composition when all you want to do is use the likes of JFrame in the way you are. So instead of extends JFrame, you could create an instance variable and set it up as you need it*
Also, I'm not sure if you did it just for the source download or whatever, but you shouldn't use the default package for your classes. Create an appropriate package structure and put your code in there.
Try and be more consistent on your use of braces enclosing blocks, and you should also try to always use them even if there is just a single line of code (this is considered best practice by some, and unnecessary by others, I'll just say that it may save you some debugging time in the future if you use them - but the main point is to pick one style and stick with it, don't mix and match)
Additional possibilities:
You have debug System.out.println() in there that you have commented out. You should look into using a logging framework like log4j, you can use a configuration file to turn on/off logging, and to have different levels of logging, etc. Log4j is probably the most common framework, and knowing how to use it will serve you well in the future.
*This outline demonstrates composition. Also classes should do a single thing, so I created a UserInputListener to handle the input from the user.
package com.jdc.snake;
public class SnakeGame {
    private JFrame frame;
    public static void main(String args[]) {
        SnakeGame game = new SnakeGame();
        game.setMapDimensions();
        while (true) {
            while (game.gameStopped) {
                // nothing goes here because we're just waiting
            game.initGame();
            game.playGame();
    public SnakeGame() {
        frame = new JFrame(APPLICATION_NAME);
        frame.setSize(WINDOW_WIDTH, WINDOW_HEIGHT);
        frame.setLocation(WINDOW_X_LOCATION, WINDOW_Y_LOCATION);
        frame.setResizable(false);
        frame.setDefaultCloseOperation(WindowConstants.EXIT_ON_CLOSE);
        frame.getContentPane().add(scoreLabel, BorderLayout.PAGE_START);
        frame.getContentPane().add(infoLabel, BorderLayout.PAGE_END);
        frame.getContentPane().add(scene, BorderLayout.CENTER);
        frame.addKeyListener(new UserInputListener());
        frame.setVisible(true);
     * Initialises all the necessary presets for a new game - creates the snake and links all the game
     * objects together - puts all the game objects to the readyToPlay state
    private void initGame() {
    void handlekeyPressed(int keyCode) {
        switch (keyCode) {
        case KeyEvent.VK_UP:
            snake.turnNorth();
            break;
        case KeyEvent.VK_DOWN:
            snake.turnSouth();
            break;
        case KeyEvent.VK_LEFT:
            snake.turnWest();
            break;
        case KeyEvent.VK_RIGHT:
            snake.turnEast();
            break;
        // game controls : Start/Stop/Pause/unPause/SpeedUp/SpeedDown
        case KeyEvent.VK_R:
            setGameStopped();
            break;
        case KeyEvent.VK_P:
            setGamePaused(!gamePaused);
            break;
        case KeyEvent.VK_PAGE_DOWN:
            gameSpeedDown();
            refreshScoreLabel();
            break;
        case KeyEvent.VK_PAGE_UP:
            gameSpeedUp();
            refreshScoreLabel();
            break;
    class UserInputListener extends KeyAdapter {
        @Override
        public void keyPressed(KeyEvent e) {
            handlekeyPressed(e.getKeyCode());
}Also, a small point, and I'm assuming you are a non-native english speaker: Dimension
Edited by: macrules2 on 27-Mar-2009 10:55