Shuttleu
2010-11-29 11:15:14
Standards are a set of rules that you should follow to ensure that the code you write is easily readable not only you but others as well. This is a must if you want to apply for SRL Members or even want help on your code, it allows people to read and understand what your doing, so if you need help, others can easily find the problem, if you apply for members, people can read what you do so they can decide if your ready. Overall it makes your code look a lot neater, nicer to look at and much easier to read.
This tutorial is for people who want to use proper standards in their scripts but want examples on how they should do them
I realised that there was not already a tutorial which done this, so i decided to write it
All information has come from the original standards post from Kaitnieks http://www.kaitnieks.com/scar/scriptingsta/
Indenting will be two spaces per level. You can indent by selecting text in Simba and pressing Tab and decrease the indent by pressing Shift+Tab.
The begin statement appears on its own line. The end statement always matches the begin statement by columns.
Do not combine two or more statements on a single line. Write each on its own line.
Use semicolons at the end of the lines except after var, begin, then, else, repeat, do and before else.
Use spaces after commas and arithmetical signs.
Not really a example for this one, but whenever you can use local variables, use them instead of global variables.
DTMs will be marked with dtm prefix.
enjoy
~shut
This tutorial is for people who want to use proper standards in their scripts but want examples on how they should do them
I realised that there was not already a tutorial which done this, so i decided to write it
All information has come from the original standards post from Kaitnieks http://www.kaitnieks.com/scar/scriptingsta/
Indenting will be two spaces per level. You can indent by selecting text in Simba and pressing Tab and decrease the indent by pressing Shift+Tab.
{YES}
begin
Writeln('Hi');
Writeln('This is indented');
end;
{NO}
begin
Writeln('Hi');
Writeln('This is not indented');
end; {YES}
i := SomeProcedure(x, y, f, r, t) + SomeProcedure(x, y, f, r, t) +
SomeProcedure(x, y, f, r, t) + SomeProcedure(x, y, f, r, t) +
SomeProcedure(x, y, f, r, t) + SomeProcedure(x, y, f, r, t);
{NO}
i := SomeProcedure(x, y, f, r, t) + SomeProcedure(x, y, f, r, t) + SomeProcedure(x, y, f, r, t) + SomeProcedure(x, y, f, r, t) + SomeProcedure(x, y, f, r, t) + SomeProcedure(x, y, f, r, t);The begin statement appears on its own line. The end statement always matches the begin statement by columns.
{YES}
begin
begin
Writeln('Hi');
Writeln('This is indented');
end;
end;
{NO}
begin
begin
begin
Writeln('Hi');
Writeln('This is indented');
end;
end;
end; Do not combine two or more statements on a single line. Write each on its own line.
{YES}
i := 1;
x := 3;
{NO}
i := 1; x := 3;Use semicolons at the end of the lines except after var, begin, then, else, repeat, do and before else.
{YES}
var
i: Boolean;
x: Integer;
begin
if (i) then
Writeln('hi')
else
begin
repeat
i := True;
until(i);
end;
for (x := 0) to 3 do
Writeln(x);
end;
{NO}
var;
i: Boolean;
x: Integer;
begin;
if (i) then;
Writeln('hi');
else;
begin;
repeat;
i := True;
until(i);
end;
for (x := 0) to 3 do;
Writeln(x);
end;
Use spaces after commas and arithmetical signs.
{YES}
i := 2 + 3 + 5;
{NO}
i := 2+3+5;{YES}
Writeln('Correct');
{NO}
Writeln( 'Incorrect' );{YES}
var
s: string;
i: Integer;
begin
for (i := 0) to 3 do
Writeln(i);
if (i = 3) then
Writeln('i = 3');
repeat
Writeln(s);
until(s = '');
end;
{NO}
Var
s: String;
i: Integer;
Begin
For (i := 0) To 3 Do
Writeln(i);
If (i = 3) Then
Writeln('i = 3');
Repeat
Writeln(s);
Until(s = '');
End;
{YES}
procedure FormatHardDrive;
{NO}
procedure formatharddrive;{YES}
procedure Proggy;
{NO}
DoStuffWithStuff{YES}
procedure Test(x, y, z, a, b, c: Integer; f, g: string);
{NO}
procedure Test(x: Integer; y: Integer; z: Integer; a: Integer; b: Integer; c: Integer; f: string; g: string);{YES}
procedure ScreenCoords(x1, y1, x2, y2: Integer);
{NO}
procedure ScreenCoords(a, b, c, d: Integer);{YES}
function ReturnNumber: integer;
begin
{do stuff}
Result := 123;
end;
{NO}
function ReturnNumber: integer;
begin
{do stuff}
end;
{YES}
var
BoneDTM, BankSymb, Flax: Integer;
{NO}
var
DTM1, DTM2, DTM3: Integer;
{YES}
var
FoundColor: Boolean;
{NO}
var
a: Boolean;{YES}
var
x, y, z: Integer;
{NO}
var x, y, z:IntegerNot really a example for this one, but whenever you can use local variables, use them instead of global variables.
DTMs will be marked with dtm prefix.
{YES}
var
dtmFishingSpot, BoneDtm: Integer;
{NO}
var
FishingSpot, Bone: Integer;{YES}
var
bmpFishingSpot, BoneBmp: Integer;
{NO}
var
FishingSpot, Bone: Integer;{YES}
var
i: Integer;
s: string;
{NO}
var
i: integer;
s: String;
{YES}
var
b: Boolean;
begin
b := True;
if (b) then
Writeln('b is true')
else
Writeln('b is false');
end;
{NO}
var
b: Boolean;
begin
if (b) then
Writeln('b is true')
else
Writeln('b is false');
end;{YES}
var
Bool1, Bool2: Boolean;
begin
Bool1 := True;
Bool2 := False;
if (Bool1 or Bool2) then
Writeln('hi');
end;
{OR}
var
Bool1, Bool2: Boolean;
function OneIsTrue: Boolean;
begin
Result := Bool1 or Bool2;
end;
begin
Bool1 := True;
Bool2 := False;
if (OneIsTrue) then
Writeln('hi');
end;
{OR}
var
Bool1, Bool2, Resultant: Boolean;
begin
Bool1 := True;
Bool2 := False;
Resultant := Bool1 or Bool2;
if (Resultant) then
Writeln('hi');
end;
{NO}
var
Bool1, Bool2: Boolean;
begin
Bool1 := True;
Bool2 := False;
if (Bool2 or Bool1) then
Writeln('hi');
end;enjoy
~shut
