diff options
Diffstat (limited to 'source/arduino/return.rst')
-rw-r--r-- | source/arduino/return.rst | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/source/arduino/return.rst b/source/arduino/return.rst new file mode 100644 index 0000000..ae3b37d --- /dev/null +++ b/source/arduino/return.rst @@ -0,0 +1,69 @@ +.. _arduino-return: + +return +====== + +Terminate a function and return a value from a function to the +calling function, if desired. + + + +Syntax: +------- + +return; + + + +return value; // both forms are valid + + + +Parameters +---------- + +value: any variable or constant type + + + +Examples: +--------- + +A function to compare a sensor input to a threshold + +:: + + int checkSensor(){ + if (analogRead(0) > 400) { + return 1; + else{ + return 0; + } + } + + + +The return keyword is handy to test a section of code without +having to "comment out" large sections of possibly buggy code. + + + +:: + + void loop(){ + + // brilliant code idea to test here + + return; + + // the rest of a dysfunctional sketch here + // this code will never be executed + } + + + +See also +-------- + +`comments <http://arduino.cc/en/Reference/Comments>`_ + |