www.delorie.com/gnu/docs/mcsim/mcsim_23.html   search  
Buy GNU books!

MCSim User' Manual

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

5.2.8 Comments on style

For your model file to be readable and understandable, it is useful to use a consistent style of notation. The example file `perc.model' follows such a consistent notation (see section B.3 `perc.model': A sample model description file). For example we suggest that:

These conventions are suggestions only. The key to have a consistent notation that makes sense to you. Consistency is one of the best ways to:

  1. Increase readability, both for others and for yourself. If you have to suspend work for a month or two and then come back to it, the last thing you want is to have to decipher your own file.

  2. Decrease the likelihood of mistakes. If all of the equations are coded with a consistent, logical convention, mistakes stand out more readily.

  webmaster     delorie software   privacy  
  Copyright 2003   by The Free Software Foundation     Updated Jun 2003