* Bug #14105 fixed - New block comments /*...*/ feature was not documented. 73/17173/5
Charlotte HECQUET [Tue, 8 Sep 2015 13:34:02 +0000 (15:34 +0200)]
Change-Id: I49d65ac5e4124a2f2c94adb5ae94b020e684a749

16 files changed:
scilab/CHANGES_6.0.X
scilab/modules/core/help/en_US/1_keywords/comments.xml
scilab/modules/core/help/en_US/1_keywords/slash.xml
scilab/modules/core/help/en_US/1_keywords/star.xml
scilab/modules/core/help/fr_FR/1_keywords/comments.xml
scilab/modules/core/help/fr_FR/1_keywords/slash.xml
scilab/modules/core/help/fr_FR/1_keywords/star.xml
scilab/modules/core/help/ja_JP/1_keywords/comments.xml
scilab/modules/core/help/ja_JP/1_keywords/slash.xml
scilab/modules/core/help/ja_JP/1_keywords/star.xml
scilab/modules/core/help/pt_BR/1_keywords/comments.xml
scilab/modules/core/help/pt_BR/1_keywords/slash.xml
scilab/modules/core/help/pt_BR/1_keywords/star.xml
scilab/modules/core/help/ru_RU/1_keywords/comments.xml
scilab/modules/core/help/ru_RU/1_keywords/slash.xml
scilab/modules/core/help/ru_RU/1_keywords/star.xml

index 58b1690..c2b5791 100644 (file)
@@ -77,6 +77,8 @@ Scilab Bug Fixes
 
 * Bug #14095 fixed - Scilab crashed when a .fig file was loaded with loadmatfile function.
 
+* Bug #14105 fixed - New block comments /*...*/ feature was not documented.
+
 * Bug #14107 fixed - lstcat of a string and a list did not produce consistent results.
 
 * Bug #14109 fixed - lsq function crashed Scilab when Scilab version depended on mkl library.
index d5c3b80..ef3612c 100644 (file)
@@ -2,7 +2,7 @@
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="comments">
     <refnamediv>
         <refname>comments</refname>
-        <refpurpose>(//) comments</refpurpose>
+        <refpurpose>(// or /*...*/) comments</refpurpose>
     </refnamediv>
     <refsection>
         <title>Description</title>
             as well as all the following characters up to the end of the lines
             are not interpreted.
         </para>
+        <para>
+            Another way to comment a block of code is to use /* at the beginning
+            and */ at the end. It is more useful than // which must be positioned at the
+            beginning of each line to comment.
+        </para>
         <para>Inside a function, the first comment lines, up to the first
             instruction or an empty line may be used to provide the default
-            contents for the function help. 
+            contents for the function help.
         </para>
     </refsection>
     <refsection>
@@ -24,6 +29,10 @@ g=9.81// the gravity
 
 text='a//b'
 
+/* As this comment is quite long to be on many lines,
+the symbols slash and star to start the comment
+and star and slash to end the comment are used */
+
 function y=myfunction(x)
   // myfunction computes y=x^2+1
   // x should be a vector or matrix
index 3095bab..514e520 100644 (file)
             Comment <code>//</code> comments a line i.e. lines which 
             begin by <code>//</code> are ignored by the interpreter.
         </para>
+        <para>
+            It is the same with <code>/*</code> which start to comment a
+            block of code and with <code>*/</code> which end to comment this block.
+        </para>
     </refsection>
     <refsection>
         <title>Examples</title>
@@ -73,6 +77,8 @@ x*B-a // close to zero
 a=4 / 2; // Should be 2
 a=2 ./ [2,4]; //     1.    0.5
 // Comments are good. They help to understand code
+/* Even long, that is to say on many lines,
+comments are useful */
  ]]></programlisting>
     </refsection>
     <refsection role="see also">
index b15b02c..3911dab 100644 (file)
             <literal>A*.B</literal>  is an operator with no predefined meaning. It may be used
             to define a new operator (see <link linkend="overloading">overloading</link>) with  the same precedence as <literal>*</literal> or <literal>/</literal>.
         </para>
+        <para>
+            <note>
+                Remark that <code>/*</code> start to comment a block of code and
+                <code>*/</code> end to comment this block.
+            </note>
+        </para>
     </refsection>
     <refsection>
         <title>Examples</title>
@@ -76,6 +82,9 @@ W' * W
             <member>
                 <link linkend="overloading">overloading</link>
             </member>
+            <member>
+                <link linkend="comments">comments</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
index bd67402..cc48828 100644 (file)
@@ -2,7 +2,7 @@
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="comments">
     <refnamediv>
         <refname>comments</refname>
-        <refpurpose>(//) commentaires</refpurpose>
+        <refpurpose>(// ou /*...*/) commentaires</refpurpose>
     </refnamediv>
     <refsection>
         <title>Description</title>
             ainsi que tous les caractères suivants jusqu'à la fin de la ligne 
             ne sont pas interprétés.
         </para>
+        <para>
+            Un autre moyen de commenter un bloc de code est d'utiliser les caractères /* pour débuter
+            un commentaire et */ pour le terminer.
+        </para>
         <para>A l'intérieur d'une fonction, les premières lignes en commentaire, jusqu'à la première 
             instruction ou la première ligne vide peuvent être utilisées comme contenu par défaut 
             pour l'aide de la fonction. 
@@ -24,6 +28,10 @@ g=9.81// La gravité
 
 text='a//b'
 
+/* Comme ce commentaire est assez long pour devoir être écrit
+sur plusieurs lignes, il est plus pratique d'utiliser
+ces symboles */
+
 function y=myfunction(x)
   // Ma fonction calcule y=x^2+1
   // x doit être un vecteur ou une matrice
index 99a187e..b3d722a 100644 (file)
         <para>
             La suite de symboles <literal>//</literal> met une ligne en commentaire, c'est à dire, les lignes commençant par <literal>//</literal> sont ignorées par l'interpréteur.
         </para>
+        <para>
+            De le même façon, <code>/*</code> débute un commentaire et <code>*/</code> termine un commentaire.
+        </para>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
+        <programlisting role="example"><![CDATA[
+a=[3.,-24.,30.];
+B=[
+   9.   -36.    30.
+  -36.   192.  -180.
+   30.  -180.   180.
+];
+x=a/B
+x*B-a // proche de zéro
+
+a=4 / 2; // Doit renvoyer 2
+a=2 ./ [2,4]; //     1.    0.5
+// Un commentaire aide à comprendre le code.
+/* Même longs, c'est à die sur plusieurs lignes,
+les commentaires sont utiles. */
+ ]]></programlisting>
     </refsection>
     <refsection role="see also">
         <title>Voir aussi</title>
index 035f63b..e9aff78 100644 (file)
             pas prédéfinie peut être utilisé pour définir de nouveaux opérateurs (voir
             <link linkend="overloading">overloading</link>) avec la même priorité que <literal>*</literal> ou <literal>/</literal>.
         </para>
+        <para>
+            <note>
+                Notez que <code>/*</code> et <code>*/</code>
+                servent à mettre un bloc de code en commentaire.
+            </note>
+        </para>
     </refsection>
     <refsection>
         <title>Exemples</title>
@@ -75,6 +81,9 @@ W' * W
             <member>
                 <link linkend="overloading">overloading</link>
             </member>
+            <member>
+                <link linkend="comments">comments</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
index 792086f..d1002cd 100644 (file)
@@ -2,7 +2,7 @@
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="comments">
     <refnamediv>
         <refname>comments</refname>
-        <refpurpose>コメント</refpurpose>
+        <refpurpose>(// or /*...*/) comments</refpurpose>
     </refnamediv>
     <refsection>
         <title>説明</title>
             この連続したスラッシュおよびその行のこれ以降の改行までの文字は
             解釈されません.
         </para>
+        <para>
+            Another way to comment a block of code is to use /* at the beginning
+            and */ at the end. It is more useful than // which must be positioned at the
+            beginning of each line to comment.
+        </para>
         <para>関数の内部で,最初の命令または空行までの最初のコメント行
             は関数ヘルプのデフォルトの内容を指定するために使用することができます.
         </para>
@@ -22,6 +27,10 @@ g=9.81// the gravity
 
 text='a//b'
 
+/* As this comment is quite long to be on many lines,
+the symbols slash and star to start the comment
+and star and slash to end the comment are used */
+
 function y=myfunction(x)
   // myfunction は y=x^2+1 を計算します
   // x はベクトルまたは行列である必要があります
index 8290ae0..0496912 100644 (file)
             コメント <code>//</code> は, 特定の行をコメントにします.
             すなわち, <code>//</code> で始まる行はインタプリタから無視されます.
         </para>
+        <para>
+            It is the same with <code>/*</code> which start to comment a
+            block of code and with <code>*/</code> which end to comment this block.
+        </para>
     </refsection>
     <refsection>
         <title>例</title>
@@ -68,6 +72,8 @@ x*B-a // ゼロに近い
 a=4 / 2; // 2となります
 a=2 ./ [2,4]; //     1.    0.5
 // コメントは有用です. コードを理解しやすくします.
+/* Even long, that is to say on many lines,
+comments are useful */
  ]]></programlisting>
     </refsection>
     <refsection role="see also">
index 83a5750..c568861 100644 (file)
             新しい演算子を定義する際に使用可能です(
            (<link linkend="overloading">オーバーロード</link>参照).
         </para>
+        <para>
+            <note>
+                Remark that <code>/*</code> start to comment a block of code and
+                <code>*/</code> end to comment this block.
+            </note>
+        </para>
     </refsection>
     <refsection>
         <title>例</title>
@@ -77,6 +83,9 @@ W' * W
             <member>
                 <link linkend="overloading">overloading</link>
             </member>
+            <member>
+                <link linkend="comments">comments</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
index 848373b..587c88e 100644 (file)
@@ -2,7 +2,7 @@
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="comments" xml:lang="en">
     <refnamediv>
         <refname>comments</refname>
-        <refpurpose>comentários</refpurpose>
+        <refpurpose>(// or /*...*/) comments</refpurpose>
     </refnamediv>
     <refsection>
         <title>Descrição</title>
             quanto o restante dos caracteres até o fim das linhas não são
             interpretados. 
         </para>
+        <para>
+            Another way to comment a block of code is to use /* at the beginning
+            and */ at the end. It is more useful than // which must be positioned at the
+            beginning of each line to comment.
+        </para>
         <para>Dentro de uma função, as primeiras linhas de comentário até a
             primeira instrução ou linha vazia podem ser usadas para fornecer o
             conteúdo padrão para a documentação de ajuda da função ("help" da função).
@@ -24,6 +29,10 @@ g=9.81// a gravidade
 
 text='a//b'
 
+/* As this comment is quite long to be on many lines,
+the symbols slash and star to start the comment
+and star and slash to end the comment are used */
+
 function y=myfunction(x)
 //  myfunction computa y=x^2+1
 // x deve ser um vetor ou uma matriz
index d70d173..55cfaf5 100644 (file)
             Comentário. <literal>//</literal> comenta uma linha, i.e. linhas que
             começam por <literal>//</literal> são ignoradas pelo interpretador.
         </para>
+        <para>
+            It is the same with <code>/*</code> which start to comment a
+            block of code and with <code>*/</code> which end to comment this block.
+        </para>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
+        <programlisting role="example"><![CDATA[
+a=[3.,-24.,30.];
+B=[
+   9.   -36.    30.
+  -36.   192.  -180.
+   30.  -180.   180.
+];
+x=a/B
+x*B-a // proche de zéro
+
+a=4 / 2; // Doit renvoyer 2
+a=2 ./ [2,4]; //     1.    0.5
+// Un commentaire aide à comprendre le code.
+/* Even long, that is to say on many lines,
+comments are useful */
+ ]]></programlisting>
     </refsection>
     <refsection>
         <title> Ver Também </title>
index cca747e..a51170d 100644 (file)
             Pode ser usado para definir um novo operador (ver <link linkend="overloading">overloading</link>) com a
             mesma precedência que * ou /.
         </para>
+        <para>
+            <note>
+                Remark that <code>/*</code> start to comment a block of code and
+                <code>*/</code> end to comment this block.
+            </note>
+        </para>
     </refsection>
     <refsection role="see also">
         <title>Ver Também</title>
@@ -36,6 +42,9 @@
             <member>
                 <link linkend="syslin">syslin</link>
             </member>
+            <member>
+                <link linkend="comments">comments</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
index 4e85b0a..26a8bbb 100644 (file)
@@ -2,7 +2,7 @@
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ru" xml:id="comments">
     <refnamediv>
         <refname>комментарии</refname>
-        <refpurpose>(//) комментарии</refpurpose>
+        <refpurpose>(// or /*...*/) comments</refpurpose>
     </refnamediv>
     <refsection>
         <title>Описание</title>
             символы вплоть до конца строки, не интерпретируются.
         </para>
         <para>
+            Another way to comment a block of code is to use /* at the beginning
+            and */ at the end. It is more useful than // which must be positioned at the
+            beginning of each line to comment.
+        </para>
+        <para>
             Внутри функции первые строки, вплоть до первой инструкции или пустой строки
             могут использоваться для указания содержимого для функции <literal>help</literal>.
         </para>
         <title>Примеры</title>
         <programlisting role="example"><![CDATA[ 
 g=9.81// ускорение свободного падения
+
 text='a//b'
+
+/* As this comment is quite long to be on many lines,
+the symbols slash and star to start the comment
+and star and slash to end the comment are used */
+
 function y=myfunction(x)
   // myfunction вычисляет y=x^2+1
   // x должен быть вектором или матрицей
   y=x^2+1
 endfunction
+
 help myfunction
  ]]></programlisting>
     </refsection>
index 04fbc7b..0412c7b 100644 (file)
             Комментарий <code>//</code> комментирует строку, т. е. строки, которые начинаются с
             <code>//</code>, игнорируются интерпретатором.
         </para>
+        <para>
+            It is the same with <code>/*</code> which start to comment a
+            block of code and with <code>*/</code> which end to comment this block.
+        </para>
     </refsection>
     <refsection>
         <title>Примеры</title>
@@ -78,6 +82,8 @@ x*B-a // близко к нулю
 a=4 / 2; // Должно быть 2
 a=2 ./ [2,4]; //     1.    0.5
 // Комментарии - это хорошо. Они помогают понять код
+/* Even long, that is to say on many lines,
+comments are useful */
  ]]></programlisting>
     </refsection>
     <refsection role="see also">
index 31a82a4..52e30e5 100644 (file)
         <para>
             <literal>A*.B</literal>  оператор без предопределённого значения. Можно использовать для определения нового оператора (см. <link linkend="overloading">перегрузку</link>) с тем же самым приоритетом, что и у <literal>*</literal> или <literal>/</literal>.
         </para>
+        <para>
+            <note>
+                Remark that <code>/*</code> start to comment a block of code and
+                <code>*/</code> end to comment this block.
+            </note>
+        </para>
     </refsection>
     <refsection>
         <title>Примеры</title>
@@ -73,6 +79,9 @@ W' * W
             <member>
                 <link linkend="overloading">перегрузка</link>
             </member>
+            <member>
+                <link linkend="comments">comments</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>