Arnica code graph conventions

October 11, 2019 by Igor Lozhkin
Developers annotate their code using comments with the purpose of explaining what a specific code block does.

When programming code is managed by Arnica WebScript, comments in the code could also be used to produce meaningful code graphs.   

Below is a summary of simple conventions which could be used to enhance the quality of code graphs. The summary is applicable to the Arnica script and Golang programming code (upcoming).

  • Comment block:
*# this is a comment block in Arnica script
//# this is a comment block in Golang

  • Code section start
*#{ this is code section start  in Arnica script
//#{ this is code section start  in Golang

  • Code section end
*#} this is code section end in Arnica script
//#} this is code section end in Golang

  • IF block:
*# this is a comment block in Arnica script, which annotates IF condition
if actual if condition

//# this is a comment block in Golang, which annotates IF condition
if actual if condition

  • THEN block:
if actual if condition 
*# this is a comment block in Arnica script, which annotates THEN section of IF condition

if actual if condition 
//# this is a comment block in Golang, which annotates THEN section of IF condition

  • ELSE block:
else
*# this is a comment block in Arnica script, which annotates ELSE section of IF condition

else
//# this is a comment block in Golang, which annotates ELSE section of IF condition

  • TRY block:
*# this is a comment block in Arnica script, which annotates TRY block 
try

  • DO WHILE block:
*# this is a comment block in Arnica script, which annotates DO WHILE block 
do while actual do condition

  • FOR LOOP block:
*# this is a comment block in Arnica script, which annotates FOR LOOP condition
for actual for condition

//# this is a comment block in Golang, which annotates FOR LOOP condition  
for actual for condition