Zeus IDE

Code: Select all

Extension: .do; .ado; .class
Line Comment1: //
Line Comment2: *
Block Comment: /* */
Case Sensitive: yes

Begin: program
  End: end
Begin: class
  End: }
Begin: if
  End: }
Begin: else
  End: }
Begin: forvalues
  End: }
Begin: foreach
  End: }
Begin: while
  End: }
Begin: quietly
  End: }
Begin: noisily
  End: }
Begin: capture
  End: }

stata has two types of end-line delimiters cr and ";" so it would be nice if a multiline commands can be folded as well (more examples below)


Some sample Code:

program define matrix_capp
	version 8

	syntax anything [, miss(str) cons ts sort]

	local b12   : word 1 of `anything'
	local colon : word 2 of `anything'
	local b1    : word 3 of `anything'
	local b2    : word 4 of `anything'

	if `"`colon'"' != ":" {
		// example of a command spaning multiple lines
		display as err ///
			`"colon expected, `colon' found"'
		// this is the same as - display as err `"colon expected, `colon' found"'
		exit 198
	}

	// will use this part later
	tempname TMP
	local cnames
	forvalues j = 1/2 {
		forvalues i = 1/`=colsof(`b`j'')' {
			matrix `TMP' = `b`j''[....,`i']
			local cnames `"`cnames' "`: colfullnames `TMP''""'
		}
	}

	if ~missing("`sort'") {
		tempname TMP bb
		local rfullb1
		local rfullb2
		forvalues i=1/`=rowsof(`b1')' {
			matrix `TMP' = `b1'[`i', ....]
			local rfullb1 `"`rfullb1' "`: rowfullnames `TMP''" "' // we can't trust rowfullnames for multi-word names
		}
		forvalues i=1/`=rowsof(`b2')' {
			matrix `TMP' = `b2'[`i', ....]
			local rfullb2 `"`rfullb2' "`: rowfullnames `TMP''" "'
		}
		local rfullb : list rfullb1 | rfullb2

		matrix `bb' = J(`nr', `nc1' + `nc2', `miss')

		forvalues i=1/`nr' {
			local ii = rownumb(matrix(`b1'), `"`: word `i' of `rfullb''"')
			local ii = rownumb(matrix(`b2'), `"`: word `i' of `rfullb''"')
			if ~missing(`ii') matrix `bb'[`i', `nc1' + 1] = `b2'[`ii', 1...]
		}
		matrix rownames `bb' = `rfullb'
		matrix colnames `bb' = `cnames'
		matrix `b12' = `bb'
		exit
	}

	matrix colnames `bb'=`cnames'
	matrix `b12' = `bb'
end

// example with ";" delimiter

#delimit ;

		graph combine gic_total gic_urban gic_rural,
				imargin(0 1 0 0) ysize(6) xsize(8) iscale(0.8)
				graphregion(color(white) style(none) margin(0 0 0 0) lstyle(none))
				plotregion (color(white) style(none));

Code: Select all

Begin: program 
  End: end 
Begin: {
  End: }

Code: Select all

* this is an example of multi-line command with cr delimiter
regress y region1 region2 region3 ///
               educ1 educ2 educ3 ///
              age male 
* the above is equivalent to
regress y region1 region2 region3 educ1 educ2 educ3 age male

Code: Select all

#delimit ;
use myfile.dta, clear;
   foreach var of varlist region1 region2 region3
                                  educ1 educ2 educ3 age male {;
         summarize `var';
   };
 #delimit cr
drop _all

Code: Select all

 forvalues i = 1/`rr'{; // no space between ' and {

Code: Select all

forvalues i = 1/`=1+`rr''{; // two ' symbols not the "

Code: Select all

* this is an example of multi-line command with cr delimiter 
regress y region1 region2 region3 /// 
               educ1 educ2 educ3 /// 
              age male 

Code: Select all

if ~missing('ii') matrix 'bb'['i', 'nc1' + 1] = 'b2'['ii', 1...]

Code: Select all

if ~missing('ii') 
{
  matrix 'bb'['i', 'nc1' + 1] = 'b2'['ii', 1...]
}

Code: Select all

// this is a one-line comment, it can be either at the begining or at the end of a line

* this is a one-line comment too, but "*" must be in the first column only
/* 
a multi-line comment, that folds correctly with the current dll
*/

/*
if (expr)
{
 something
}

is invalid syntax in Stata, we have three rules:
1. the open brace must appear on the same line as if, else, forvalues, foreach, while, and class
2. nothing may follow the open brace (except comments), the first command to be executed must appear on a new line.
3. the close brace must appear on a line by itself.
*/

 // so the "usual" syntax would be:

forvalues i = 1/10 { // comments may be here
   ...
   ...
}

// the expression may contain symbols "{" and/or "}" so for a begin fold
// we should be looking for the last "{" in the line:

if ${globalname} == 5{ // and notice that space can be ommited between
                                   // 5 and "{"
 ... do something
}

/* there can be long expressions splitted into multipe lines */

if (`dataischange' == 1 | `userrequestedsave' == 1)    ///
  & `fileiswritable' == 1 {
  ... do something to save the file...
}

// of course we have a single command version of if/else where {} are
// not required

if `a' = 4 display "a equals to 4"

// class, forvalues, foreach, while MUST use braces even if there is only one command to execute

Code: Select all

#delimit ;
generate a = 0; replace a = 1 if b > 100;

local i = 0;
while `i' < 10 {;
  display `i';
  local ++i;
};

// and although not aesthetically pleasing, this is a valid syntax:

forvalues i = 1/10 {; display `i';};

/* with ; delimiter we don't need to use /// to split long lines so, our multi-line if from above would look like:
*/
if (`dataischange' == 1 | `userrequestedsave' == 1)    
  & `fileiswritable' == 1 {;
  ... do something to save the file...;
};

Code: Select all

somehow this latest version has more problems then the previous one:

Code: Select all

if (`dataischange' == 1 | `userrequestedsave' == 1)    ///
  & `fileiswritable' == 1 {
  ... do something to save the file...
}

Code: Select all

// of course we have a single command version of if/else where {} are
// not required
if `a' = 4 display "a equals to 4"

Code: Select all

* this is an example of multi-line command with cr delimiter
regress y region1 region2 region3 ///
               educ1 educ2 educ3 ///
              age male

Code: Select all

* this is a one-line comment too, but "*" must be in the first column only

Code: Select all

if (`dataischange' == 1 | `userrequestedsave' == 1)    ///
  & `fileiswritable' == 1 {
  ... do something to save the file...
}

Code: Select all

* this is an example of multi-line command with cr delimiter