Author: sebastien.lelong
Date: Thu Oct  9 09:57:18 2008
New Revision: 379

Modified:
    wiki/JalapiWelcome.wiki

Log:
Few words about long dash lines.

Modified: wiki/JalapiWelcome.wiki
==============================================================================
--- wiki/JalapiWelcome.wiki     (original)
+++ wiki/JalapiWelcome.wiki     Thu Oct  9 09:57:18 2008
@@ -25,7 +25,7 @@

  == How to write comments ==

-The two following examples show how to comment correctly your code so  
*jalapi* can extract them.
+The two following examples show how to comment correctly your code so  
*jalapi* can extract them.

  *good*
  {{{
@@ -52,7 +52,21 @@

  *jalapi* is also converting your comments in html, following the Google  
Code Wiki Markup Syntax. That is, you can add bullet list, tables, etc...  
just you'd do here, in a wiki page. _But_, while GC wiki doesn't respect  
line feeds (or carriage return), *jalapi* tries to keep your carriage  
return: when there's a "`\n`", it produces an "`<br/>`" html element.

-Finally, keep in mind the following rules: _don't make too fancy  
comments_. While this sounds beautiful in your code (though it can be heavy  
to read), it'll be converted to html, and this can sometime produces weird  
things. So, avoid writing long dashes lines to separate your block, etc...
+Finally, keep in mind the following rules: _don't make too fancy  
comments_. While this sounds beautiful in your code (though it can be heavy  
to read), it'll be converted to html, and this can sometime produces weird  
things.
+
+Exception: long dash lines, used to ease the identification of code block,  
can be used in a jal file, but will be removed while generating html. To be  
precise, everything starting with "-- -" will be ignored. Ex:
+
+{{{
+-- --------------------
+-- this is my comment
+-- --------------------
+procedure blabla() is
+   --
+end procedure
+}}}
+
+will only keep "this is my comment".
+

  *Keep it simple !*

@@ -90,7 +104,5 @@
  }}}

  That is, it takes a path to either `validated` or `unvalidated` map. It  
automatically find libraries, sets SAMPLEDIR, add files to the `doc/html`  
directory and correctly set SVN properties.
-
-



--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"jallib" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at 
http://groups.google.com/group/jallib?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to