summary refs log tree commit diff stats
path: root/doc/tut1.txt
diff options
context:
space:
mode:
authorAraq <rumpf_a@web.de>2014-09-07 00:58:31 +0200
committerAraq <rumpf_a@web.de>2014-09-07 00:58:31 +0200
commit1cdb8022d00c4a17f5f411ed6d74bcc28f863b30 (patch)
treee16f70c34f73fcae18b13b034ed6ab62f0e4e137 /doc/tut1.txt
parentef001573df9405dff94a763fc3dac6f3e1943738 (diff)
downloadNim-1cdb8022d00c4a17f5f411ed6d74bcc28f863b30.tar.gz
changed comment handling (breaking change)
Diffstat (limited to 'doc/tut1.txt')
-rw-r--r--doc/tut1.txt47
1 files changed, 8 insertions, 39 deletions
diff --git a/doc/tut1.txt b/doc/tut1.txt
index 73d90b008..b90736bd0 100644
--- a/doc/tut1.txt
+++ b/doc/tut1.txt
@@ -112,50 +112,19 @@ Comments
 --------
 
 Comments start anywhere outside a string or character literal with the
-hash character ``#``. Documentation comments start with ``##``. Multiline
-comments need to be aligned at the same column:
+hash character ``#``. Documentation comments start with ``##``:
 
 .. code-block:: nim
+  # A comment.
+ 
+  var myVariable: int ## a documentation comment
 
-  i = 0     # This is a single comment over multiple lines belonging to the
-            # assignment statement.
-  # This is a new comment belonging to the current block, but to no particular
-  # statement.
-  i = i + 1 # This a new comment that is NOT
-  echo(i)   # continued here, because this comment refers to the echo statement
 
+Documentation comments are tokens; they are only allowed at certain places in
+the input file as they belong to the syntax tree! This feature enables simpler
+documentation generators.
 
-The alignment requirement does not hold if the preceding comment piece ends in
-a backslash:
-
-.. code-block:: nim
-  type
-    TMyObject {.final, pure, acyclic.} = object  # comment continues: \
-      # we have lots of space here to comment 'TMyObject'.
-      # This line belongs to the comment as it's properly aligned.
-
-
-Comments are tokens; they are only allowed at certain places in the input file
-as they belong to the syntax tree! This feature enables perfect source-to-source
-transformations (such as pretty-printing) and simpler documentation generators.
-A nice side-effect is that the human reader of the code always knows exactly
-which code snippet the comment refers to. Since comments are a proper part of
-the syntax, watch their indentation:
-
-.. code-block::
-  echo("Hello!")
-  # comment has the same indentation as above statement -> fine
-  echo("Hi!")
-    # comment has not the correct indentation level -> syntax error!
-
-**Note**: To comment out a large piece of code, it is often better to use a
-``when false:`` statement.
-
-.. code-block:: nim
-  when false:
-    brokenCode()
-
-Another option is to use the `discard statement`_ together with *long string
+You can also use the `discard statement`_ together with *long string
 literals* to create block comments:
 
 .. code-block:: nim