Jump to content

Basic Java Naming Conventions [SIMPLE] [Mini-Tut]


Team Cape
 Share

Recommended Posts

If I've missed any, let me know and I'll add them. It seems like a lot of people are having problems with this, so I want to fix this up. It's a very simple thing that greatly improves the readability of your code

 

Variables:

 

All variable names should start with a lower case letter for the sake of clarity.

 

Example:

private long time = System.currentTimeMillis();

Another example:

private Area area = new Area(1, 2, 3, 4);

 Notice how the names in both are lower case.

 

If you want to make a variable with more than 1 word, you would capitalize the first letter of the second word.

private Area theArea = new Area(1, 2, 3, 4);
private long timeStarted = System.currentTimeMillis();

Note that methods follow essentially the same format. 

 

Examples:

public int onLoop() {
    return 0;
}

Note that the first word is not capitalized, but the second word is capitalized. 

public void eat() {
}

The first word is also not capitalized. Simple, right?

 

Constants

This is used for values such as widget ID's - values that are final that never changed.

 

All letters are upper case and instead of putting a capital letter to start a new word, instead put a _ to signify a space.

private static final int SOME_ID = 57;
public static final int TIN_ROCK_COLOUR = 53;

Thanks to @@Transporter for reminding me to put this in smile.png

 

Objects and class definitions

 

Classes define objects, and their first letter is always capitalized so people know that a class is being referenced.

Notice how we said:

private Area theArea = new Area(1, 2, 3, 4);

The 'Area' object has a capital first letter, so we know we're not referencing another variable, for instance the one we named just before called 'area'.

 

If we are defining a class, we would do it like so:

public class Thing {
   //attributes
}

*** Notice the upper case first letter! ***

 

If we wanted to define a 'Thing', then we would say:

Thing something = new Thing();

    ^ capitalized                         ^ capitalized

 

Enums

If you're not familiar with what enums is, but you're still coding on OSBot, this will probably look familiar to you:

private enum State {
     BANK,
     MINE,
     RUN_AWAY
};

Notice that all letters are capitalized. This is how enums are named - exactly like the static IDs from before.

 

This is a very simple task that takes about 5 seconds to learn. If you're not going to properly format your code, and you ask someone for help, you will come across as either very unknowledgeable or just lazy. If you have any questions, please feel free to ask smile.png. If I made any mistakes, tell me - I wrote this up in about 5 minutes.

 

 

 

Edited by Imateamcape
  • Like 7
Link to comment
Share on other sites

private Area theArea = new Area(1, 2, 3, 4);

This is normally refereed to as lower camel case. 

 

Another thing you could include is constants, which you use full capitals and separate words with the _ character. 

 

e.g 

public static final int TIN_ROCK_COLOUR = 53;

 

true i'll add that in now :)

Link to comment
Share on other sites

I flat-out don't allow scripters to use .NET bracket conventions on the SDN. It's one of my triggers. 

 

sleep(random(4000000,6000000))

 

11/10 antiban

 

Edit: Also @@Imateamcape you could add function javadoc, not that I think a ton of people use it but its a good intro none the less.

Edited by k9thebeast
  • Like 1
Link to comment
Share on other sites

sleep(random(4000000,6000000))

 

11/10 antiban

 

Edit: Also @@Imateamcape you could add function javadoc, not that I think a ton of people use it but its a good intro none the less.

 

i added in method formatting at the end of variables section because its essentially the same format smile.png (even though they're not variables)

Edited by Imateamcape
Link to comment
Share on other sites

i added in method formatting at the end of variables section because its essentially the same format smile.png (even though they're not variables)

 

Ah meant like the description on the top

/**
 * Whats this function do?
 * @param  url  an absolute URL giving the base location of the image
 * @param  name the location of the image, relative to the url argument
 * @return      the image at the specified URL
 * @see         Image
 */

 public Image getImage(URL url, String name) {
        try {
            return getImage(new URL(url, name));
        } catch (MalformedURLException e) {
            return null;
        }
 }
  • Like 1
Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

 Share

  • Recently Browsing   0 members

    • No registered users viewing this page.
×
×
  • Create New...