[shanapu]

I've seen here many different coding styles. And I asked myself - and now I ask you - which of these two examples do you prefer in consideration of the readability, maintain & performance.
Or is there even a performance deviation at all?

PHP Code:

public Action Some_Command(int client, int args)
{
    if (IsClientConnected(client))
    {
        if (CVAR.BoolValue)
        {
            if (GetClientTeam(client) == 1)
            {
                // Do some fanzy stuff
            }
            else PrintToChat(client, "nope");
        }
        else PrintToChat(client, "nope");
    }
    
    return Plugin_Handled;
} 


PHP Code:

public Action Some_Command(int client, int args)
{
    if (!IsClientConnected(client))
        return Plugin_Handled;
    
    if (!CVAR.BoolValue)
    {
        PrintToChat(client, "nope");
        return Plugin_Handled;
    }
    
    if (GetClientTeam(client) != 1)
    {
        PrintToChat(client, "nope");
        return Plugin_Handled;
    }
    
    // Do some fanzy stuff
    
    return Plugin_Handled;
} 


Ok, there are many other variation possibilities to save some lines. But they will clearly decrease the readability.

PHP Code:

public Action Some_Command(int client, int args){
    if (IsClientConnected(client)){
        if (CVAR.BoolValue){
            if (GetClientTeam(client) == 1){
                // Do some fanzy stuff
            }else PrintToChat(client, "nope");
        }else PrintToChat(client, "nope");
    }return Plugin_Handled;
} 


PHP Code:

public Action Some_Command(int client, int args){
    if (!IsClientConnected(client)) return Plugin_Handled;
    if (!CVAR.BoolValue){
        PrintToChat(client, "nope");
        return Plugin_Handled;
    }
    if (GetClientTeam(client) != 1){
        PrintToChat(client, "nope");
        return Plugin_Handled;
    }
    // Do some fanzy stuff
    return Plugin_Handled;
} 


Point readability: What's in your opinion most important for a clean & readable code?

Comments?
How to name variables/function?
Use 'many' space lines / shrink the size?
Grouping of functions/forwards/...?
old/new syntax?
Something I've forgotten?

and why?

or do you just feel like
"f?#k readability! what is style? most important is the functionality!"?


Maybe you got some other code style examples with their dis-/advantages.

[Guccci]

example #2 spacing and neatness/straightness

[Deathknife]

PHP Code:

public Action Some_Command(int client, int args) {
    if (!IsClientConnected(client))
        return Plugin_Handled;
    
    if (!CVAR.BoolValue) {
        PrintToChat(client, "nope");
        return Plugin_Handled;
    }
    
    if (GetClientTeam(client) != 1) {
        PrintToChat(client, "nope");
        return Plugin_Handled;
    }
    
    // Do some fanzy stuff
    
    return Plugin_Handled;
} 


[OSWO]

This is all user preference. You can't be asking an answer to an opinion.

Also if you use spaces and not tabs. End yourself.

I personally use this style:

PHP Code:

public Action function() {
    if (IfStatement) {

    } else if (ElseIfStatement) {

    }

    if (Plugin_Handled) {
        return Plugin_Handled;
    }

    if (Plugin_Stop) {
        return Plugin_Stop;
    }
} 


[xines]

My List would be:

1. Performance.
2. Readability.

Performance first because, i would rather drive a ugly car thats working correctly than driving a pretty car that can't even start. Also along the way you can use the commenting style to define your functions and their use for yourself & others to know:

1:

PHP Code:

//My Comment 


2:

PHP Code:

/*My Comment*/ 


Q. How to name variables/function?
A. Simple as short as you possible can without breaking the readability.
Example: using function "OnGameFrame" ticks about 66 times a secound tho it depends on the Servers FPS rate, so there is a big difference here in having variables named with 50 bytes than with 10 bytes.

Q. Use 'many' space lines / shrink the size?
A. Just stick to use TABS which equals to 4 spaces.

Spoiler for why to use tabs (Stolen from some random site):

Spoiler

Tabs

• Allow mistakes to be more noticeable, it's annoying to micro manage to spaces.
• Are consistent, they are only used for indentation, unless you are commenting wrong.
• Are customizable, you can specify in the options of the editor how wide they are.
• Are more productive, why type 4 spaces when ye can hit 1 tab.
• Take less size than multiple spaces.
• Take more space than a space.
• Take less time to go through.
• Tend to work better in IDEs.

Q. old/new syntax?
A. NEW SYNTAX Why even question this.

[nosoop]

Group related functionality when possible and don't repeat things if you don't have to. If the control flow is weird, put failure states in early.

Maintainability's important. You'll want to know what you're looking at when you come back to it after a few months.

If you asked me to implement Some_Command with all the same functions, I would've done it like this:

public Action Some_Command(int client, int argc) {
    // We do want to print a message to the client on any failure, so enclose it all with the client check.
    // Though really, you can just check "if (client)" since they'll be connected for that particular callback unless it's called by the server (index 0).
    if (IsClientConnected(client)) {
        if (hCvar.BoolValue && GetClientTeam(client) == 1) {
            // Do your stuff.
            // If doing stuff gets really long and complex, I'd move it to a new DoYourStuff(int client) function at some point.
        } else {
            // Don't repeat yourself -- the above conditions can be compacted down to one check.
            // Rewrite the block and expand on it if you have to later.
            PrintToChat(client, "nope");
        }
    }
    return Plugin_Handled;
}

Of course, not that many comments; the simpler stuff should be self-documenting, larger blocks get a quick explanation of purpose.

[Mitchell]

public Action Some_Command(int client, int args) { if (!IsClientConnected(client)) { return Plugin_Handled; } if (!CVAR.BoolValue) { PrintToChat(client, "nope"); return Plugin_Handled; } if (GetClientTeam(client) != 1) { PrintToChat(client, "nope"); return Plugin_Handled; } return Plugin_Handled; }

courtesy of my fuckitup.py script.

[Powerlord]

Originally Posted by Mitchell public Action Some_Command(int client, int args) { if (!IsClientConnected(client)) { return Plugin_Handled; } if (!CVAR.BoolValue) { PrintToChat(client, "nope"); return Plugin_Handled; } if (GetClientTeam(client) != 1) { PrintToChat(client, "nope"); return Plugin_Handled; } return Plugin_Handled; } courtesy of my fuckitup.py script.

This isn't JavaScript, you don't need to minify it. ;)

[fakuivan]

Originally Posted by xines Q. How to name variables/function? A. Simple as short as you possible can without breaking the readability. Example: using function "OnGameFrame" ticks about 66 times a secound tho it depends on the Servers FPS rate, so there is a big difference here in having variables named with 50 bytes than with 10 bytes.

Wut? Isn't the jit dealing with that kind of optimization?

[headline]

Originally Posted by fakuivan Wut? Isn't the jit dealing with that kind of optimization?

Uhh what? Variable naming doesn't matter after compilation, he's referring to some sort of convention.


When I was learning SourceMod ThatOneGuy taught me how to stay completely organized by prefixing all variables with their type and if they're global or not so it's simple to tell, for example...

This really helped me when I was starting

PHP Code:

/* Globals */
ga_iSomeArray[MAXPLAYERS + 1];
g_iSomeInt;
g_fSomeFloat;
gcv_iSomeCvarInteger

/* Locals */
iSomeLocalVariable 


As far as your example you posted my spin would be something like this...

Spoiler

PHP Code:

public Action Some_Command(int client, int args) 
{ 
    if (!IsClientConnected(client)) 
    { 
        ReplyToCommand(client, "[SM] You must be in game to use this command!");
        return Plugin_Handled;
    }
    
    if (CVAR.BoolValue) 
    { 
        if (GetClientTeam(client) == 1) 
        { 
            // Do some fanzy stuff 
        } 
        else
        {
            PrintToChat(client, "nope"); 
        }
    }
    else
    {
        PrintToChat(client, "nope"); 
    }
     
    return Plugin_Handled; 
} 


In the end - assuming everything's working okay - it's all about readability and if my padded, spacey (and in my opinion) clean style makes it easier for someone to understand then that's all that matters to me. I don't write for just myself

However recently I've been doing camel notation on SM 1.7 things that have a class