General Discussions

**Learning Newbie** · 02-13-2008, 03:06 PM

I know, there's a coding forum. There's also an ASP, PHP, and even database (also known as SQL) forum. I'm not interested in any particular programming language. And since this is a web site that attracts people with tech knowledge, I think we've all done a bit of coding.

So I'm curious what your own rules and best practices are for white space in your code?

A coworker told me a single blank line between blocks of code is a life saver, but two or more blank lines should never be used. He says it's bad form and glosses over bigger structural problems. Personally, I like to break up a big chunk of code into smaller related bits, and use a blank line or even 2 or 3 depending on just how related they are. I don't think it makes sense to break something out into a new method unless it's actually used in several places - functions are for shared functionality, not for organization.

I save the files with my tabs as spaces, so if someone opens a code file but their tab size is set to 8, they can still read my code.

I use 3 spaces in a tab. And I use "smart indenting" which I think since .NET came along, everybody else does. When you go into a control flow block (if, while, do, all that), that block should be indented.

So what are your rules?

**ForrestCroce** · 02-13-2008, 10:25 PM

I can't stand code with spaces instead of tabs. That's the whole point to setting tab spacing ... leave the fact that something has been indented in the file, but leave it up to the client to do the indenting according to the end user's taste.

**ADAM Web Design** · 02-14-2008, 01:54 AM

Me either. If their tab size is set too large, then nuts to 'em.

My rule is this: one line of blank space between any sub or function. Tabs for indents. And I'm good to go.

**Mooofasa** · 02-14-2008, 04:39 AM

I'm a comment whore with PHP (and was with VB).

As for white space, I use the following.

Code:

a (b()) {
  c (d()) {
    e ...
  }
  
  f (g()) {
    h ...
  }
}

**Learning Newbie** · 02-15-2008, 01:47 PM

Wow, Moofster - do you do any LISP or F# coding? You look like you have set theory down.

**Mattmaul1992** · 02-15-2008, 05:19 PM

I use tabs and lots of blank lines.. I just really don't see how one blank line is going to screw up the program. I mean it makes it easier to read and doesn't affect the program so how could it be bad? I like to separate my programs into sections and each type of section is separated by a certain number of lines. If I don't do this I make big comments for each section like -

PHP Code:


			
//--------------------------------------+
// NEWS - Add Post
//--------------------------------------+

I think that's the best way to do it..

**joder** · 02-15-2008, 10:16 PM

I use spaces for tabs and 4 space indent. 1 blank line between sections.

**serandfae** · 02-16-2008, 12:07 AM

I use tabs, and use one comment line between sections. Makes it a lot easier should I need to update or base something new from old. But that's if I'm feeling industrious.

**cbwm** · 10:16 AM

Isn't coding style, spacing included, client depedent? If they pay well, and are likely to bring you back:

// *********************************
// Function: someFunction
// Description: Does something complicated with the customer name
// Return Value: (String) Newly Modified Customer Name
// *********************************
function someFunction(

string sCustomerName, // The customer's name
int iOtherArgument, // Description of other Argument
int iYetAnotherArgument)// Description of this Argument

{

// Parse customer name into first and last
string sCustomerFirstName = left(sCustomerName, pos(sCustomerName," ");
..
..

// Some other comment
someOtherVar= someOtherFunction(sCustomerFirstName);

..
return someOtherVar;

}

// *********************************
// Function: someOtherFunction
// Description: Does something with its argument
// Return Value: (vartype) description of the return value
// *********************************
function someOtherFunction(

vartype vtDescriptiveVarName, // comment describing argument
vartype vtDescriptiveVarName2, // comment describing argument

{

// Comment describing code block
..
..

// Some other descriptive code blockcomment
someOtherVar= yetAnotherFunction(vtSomeVar);
..

return someOtherVar;

}

On the other hand, if the contract is low paying( or extremely high paying and the contractor is a pr*ck who just wants you in and out ASAP), something like this might be more appropriate:

function sF( string sCName, int iOA,int iYAA)
{

return sOF(left(sCN,pos(sCN," ")..);

}
function sOF(vartype vtNDVN,vartype vtNDVN2)
{

..;..;return yAF( vtNDVN);

}

Spacing and comments are really for the maintenance programmer, not the original author.

**tripy** · 11:14 AM

I personally use spaces, as that when I use to access my files remotely, vim messes my files completely.
And I never bothered searching the command to adjust the tab/spaces value.

PHP Code:


			
$variable="test";
if(true){
  //...
}
else{
  //...
}

switch($var){
  case '1':
    //...
    break;
  case '2':
  default:
    //...
    break;
}
class clSomething(){
  private $var;

  public function __construct($var){
    //...
  }
  
  private function _priv(){
    return false;
  }
}

**joder** · 02-17-2008, 03:04 PM

Quote:

Originally Posted by tripy

I personally use spaces, as that when I use to access my files remotely, vim messes my files completely.
And I never bothered searching the command to adjust the tab/spaces value.

This is what is in my .vimrc

Code:

set tabstop=4
set shiftwidth=4
set expandtab

set et
set sw=4
set smarttab

**tripy** · 02-17-2008, 05:00 PM

Thank you James.
Now, I just have to replicate this through every instances of vim I could use...