index

Varkon MBS Programmers manual


Comments

The exclamation mark "!" is used to indicate the beginning of a comment and the "end of line" ends a comment. All characters on the rest of the line after an exclamation mark are skipped by the compiler. Here is an example...

  !******************************************************
  !*
  MODULE  plate_10X10( ! Creates a plate size 10 by 10
    FLOAT t); ! Thickness of plate
  !*
  !* (C)2008-01-14 The Author
  !*
  !* Revisions: None
  !*
  !******************************************************

  BEGINMODULE

    lin_free(#1,vec(0,0),vec(10,0)); ! The lower horisontal line
    lin_offs(#2,#1,-10);             ! The upper horisontal line
    lin_free(#3,on(#1),on(#2));      ! A line connecting startpoints
    lin_free(#4,on(#1,1),on(#2,1));  ! A line connecting endpoints

  ENDMODULE

  !******************************************************

Dont be sparse with comments. You can also increase readability by indenting and using lower and upper characters in a systematic way. A piece of code like the one above is definitely much easier to understand than the following.

  module plate_10X10(float t);
  beginmodule
  lin_free(#1,vec(0,0),vec(10,0));
  lin_offs(#2,#1,-10);
  lin_free(#3,on(#1),on(#2));
  lin_free(#4,on(#1,1),on(#2,1));
  endmodule

It is possible to let a comment continue over many lines by using the same "/*" and "*/" notation as in the C programming language.

  /* A multiline comment starts here
     and continues
     and continues
     and continues
     and ends here */

SourceForge.net Logo

Varkon 1.19D svn # 120M