aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/arduino/comments.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@mit.edu>2010-11-21 01:40:37 -0500
committerMarti Bolivar <mbolivar@mit.edu>2010-11-21 01:40:37 -0500
commit19e8336afbc827378216aca2b1af45ef89a108ab (patch)
tree5aeb911d2f697ab3bf6ad9cf3609c19fe7a83346 /docs/source/arduino/comments.rst
parentb2653be281539928a7ba92433fe2b7c2e3ef4cd4 (diff)
downloadlibrambutan-19e8336afbc827378216aca2b1af45ef89a108ab.tar.gz
librambutan-19e8336afbc827378216aca2b1af45ef89a108ab.zip
updated serial bootloader spec; other improvements
Diffstat (limited to 'docs/source/arduino/comments.rst')
-rw-r--r--docs/source/arduino/comments.rst10
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/source/arduino/comments.rst b/docs/source/arduino/comments.rst
index e46fc48..b50aa0f 100644
--- a/docs/source/arduino/comments.rst
+++ b/docs/source/arduino/comments.rst
@@ -14,19 +14,23 @@ One use for comments is to help you understand (or remember) how your
program works, or to inform others how your program works. There are
two different ways of making comments.
+.. _arduino-comments-singleline:
+
**Single line comment**: Anything following two slashes, ``//``, until
the end of the line, is a comment::
x = 5; // the rest of this line is a comment
+.. _arduino-comments-multiline:
+
**Multi-line comment**: Anything in between a pair of ``/*`` and ``*/``
is a comment::
-
+
/* <-- a slash-star begins a multi-line comment
all of this in the multi-line comment - you can use it to comment
out whole blocks of code
-
+
if (gwb == 0){ // single line comment is OK inside a multi-line comment
x = 3;
}
@@ -60,4 +64,4 @@ is cryptic or unhelpful.
-.. include:: cc-attribution.txt \ No newline at end of file
+.. include:: cc-attribution.txt