blob: b4ef5fdca1c84c5d29edfff504de47d47d47b797 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
.. highlight:: cpp
.. _lang-return:
``return``
==========
Terminates a function and return a value from a function to the
calling function, if the function has non-``void`` return type.
Syntax:
-------
::
// from within a "void" function:
return;
// from within a non-"void" function:
return value;
In the second case, ``value`` should have a type which is the same as
the return type of the function, or be convertible to it (like an
``int`` to a ``double``, etc.; see :ref:`this note
<lang-arithmetic-typeconversion>` for some references).
Examples:
---------
A function to compare a sensor input to a threshold::
// converts analog readings between 0 and 400 to 0, and 400 up to 1.
int checkSensor() {
if (analogRead(0) > 400) {
return 1;
else {
return 0;
}
}
An early ``return`` is also useful when testing a section of code
without having to "comment out" large sections of possibly buggy code,
like so::
void loop() {
// brilliant code idea to test here
return;
// the rest of a dysfunctional sketch here
// this code will never be executed
}
See Also
--------
- :ref:`comments <lang-comments>`
.. include:: cc-attribution.txt
|
