SBML.org — the global portal for all things SBML

Coding conventions

Contents

Conventions to follow when adding code to libSBML

The following are guidelines that have generally been followed in libSBML code. Not every piece of code adheres to them but we are trying to move to a point where the code is as consistent as possible.

The following are the main issues.

Do not be afraid of whitespace

  1. Indentation should be in multiples of 2 spaces
  2. Line length should never exceed 80 columns
  3. There should be 2 blank lines between each function definition in a header file
  4. There should be 2 blank lines between each function in a code file


Good Bad
void function1()
{
  if (statement)
  { 
    some_other_very_long_
      statement_that_goes_on_and_on;
  }
}


void func2()
{
  do_nothing;
}
void function1()
{ if (statement) some_other_very_long_statement_that_goes_on_and_on;
}
void func2(){ do_nothing; }
 

Function code

  1. Curly brackets should have their own line
  2. Any return statement should be on a separate line
  3. Bracket sub-code to illustrate scope
  4. Leave blank lines between distinct bits of code
  5. Line up similar notation e.g. equals signs
  6. Leave spaces around operators/keywords
Good Bad
void function1()
{
  if (statement)
  { 
    a     = 6;
    do_b  = 7;
  }

  return c;
}

void function1()
{  a=6;
   bbbb=5;
if (statement) return c;
}
 

Add tests

Naming variables

Retrieved from "http://sbml.org/SBML_Projects/libSBML/Coding_conventions"

This page was last modified 15:06, 10 June 2012.



Please use our issue tracking system for any questions or suggestions about this website. This page was last modified 15:06, 10 June 2012.