• Announcements

    • khawk

      Download the Game Design and Indie Game Marketing Freebook   07/19/17

      GameDev.net and CRC Press have teamed up to bring a free ebook of content curated from top titles published by CRC Press. The freebook, Practices of Game Design & Indie Game Marketing, includes chapters from The Art of Game Design: A Book of Lenses, A Practical Guide to Indie Game Marketing, and An Architectural Approach to Level Design. The GameDev.net FreeBook is relevant to game designers, developers, and those interested in learning more about the challenges in game development. We know game development can be a tough discipline and business, so we picked several chapters from CRC Press titles that we thought would be of interest to you, the GameDev.net audience, in your journey to design, develop, and market your next game. The free ebook is available through CRC Press by clicking here. The Curated Books The Art of Game Design: A Book of Lenses, Second Edition, by Jesse Schell Presents 100+ sets of questions, or different lenses, for viewing a game’s design, encompassing diverse fields such as psychology, architecture, music, film, software engineering, theme park design, mathematics, anthropology, and more. Written by one of the world's top game designers, this book describes the deepest and most fundamental principles of game design, demonstrating how tactics used in board, card, and athletic games also work in video games. It provides practical instruction on creating world-class games that will be played again and again. View it here. A Practical Guide to Indie Game Marketing, by Joel Dreskin Marketing is an essential but too frequently overlooked or minimized component of the release plan for indie games. A Practical Guide to Indie Game Marketing provides you with the tools needed to build visibility and sell your indie games. With special focus on those developers with small budgets and limited staff and resources, this book is packed with tangible recommendations and techniques that you can put to use immediately. As a seasoned professional of the indie game arena, author Joel Dreskin gives you insight into practical, real-world experiences of marketing numerous successful games and also provides stories of the failures. View it here. An Architectural Approach to Level Design This is one of the first books to integrate architectural and spatial design theory with the field of level design. The book presents architectural techniques and theories for level designers to use in their own work. It connects architecture and level design in different ways that address the practical elements of how designers construct space and the experiential elements of how and why humans interact with this space. Throughout the text, readers learn skills for spatial layout, evoking emotion through gamespaces, and creating better levels through architectural theory. View it here. Learn more and download the ebook by clicking here. Did you know? GameDev.net and CRC Press also recently teamed up to bring GDNet+ Members up to a 20% discount on all CRC Press books. Learn more about this and other benefits here.
Sign in to follow this  
Followers 0
Joshua D Farrow

Code Formatting - Method Organization

4 posts in this topic

Is there a way that my methods should be organized?

 

Ex: By order that they are called, by name, by the order that they pop up in my brain (haha).

 

I currently use NetBeans as my primary IDE. If anyone else uses it, do you know if there is a way of using the GUI to move methods around, something that is the equivalent to moving folders/files around in Windows Explorer/Finder? I know that it has a handy method list that shows all the current methods, as well as allowing the coder to quickly move between methods by simply clicking on the one of their choice. However, there doesn't seem to be a way to reorganize the methods, short of simply copying and pasting them into place.

0

Share this post


Link to post
Share on other sites

I place constructors at the top the class and then I'll usually group public and private methods together and within those groups I'll try to keep closely related methods (accessor methods, for example) in close proximity to one another. Granted, all methods in a class should be related but some are more so than others. wink.png

 

In regards to NetBeans' refactoring options, I don't believe you can reorder methods in a class automatically.

1

Share this post


Link to post
Share on other sites

Personally i structure my classes as so:

 

public class FooBar
{
    //Static Fields
    public static int SomeNumber = 32;
    private const string SomeString = "Blllarrghhh";
    
    //Fields
    public string MyName;
    
    // Properties (C#)
    public int MyAge { get; set;}
    
    //Constructors
    public FooBar()
    {
    
    }
    
    
    //Methods
    private void SetName() { ... }
    public void GetName { ... }
    
    public void IncrementAge() {... }
    
    public int SomeReallyLongFunction(int param1, int param2, int param3, string param4, object[] param5) { ... }
 
    #region Any Interface Implementations
    #endregion

}

 

The way i order functions is as follows:

- I Try to keep Private functions at the top of the methods section and public below

- Group methods todo with the same operation (E.g. Set/Get Name)

- Order them by NUmber of parameters where possible

- Interface implementations at the bottom of the class (regardless of Methods / Fields)

1

Share this post


Link to post
Share on other sites

With most IDE's it isn't necessary to organize methods at all, since you have several representations of the complete class structure and you can easily jump to the method you want.

That said however, it is possible that not everybody reading your code will use an IDE. So it pays off to organize your code in some way (other than how they popup in your head ;)).

I actually have serveral different ways of organizing my code, they depend on the language (C#, C++, PHP), the kind of project (work related, hobby or learning) and the mood I am in... but I try to organize methods with the same functionality together.

 

Typicly I don't mark regions of functionality with comments or the C# #region keyword. (because I think unnecessary comments are evil...)

1

Share this post


Link to post
Share on other sites

Typicly I don't mark regions of functionality with comments or the C# #region keyword. (because I think unnecessary comments are evil...)

 

After the responses about using comments on my other post, I went back and looked at all of the comments that I had placed within my code. For the majority of them, all it took was re-reading them to realize that they were completely unnecessary laugh.png

0

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!


Register a new account

Sign in

Already have an account? Sign in here.


Sign In Now
Sign in to follow this  
Followers 0