docs: adjust standard comment docs format

Author: antfu

documentation/Standard-Lib.md

@@ -4,7 +4,7 @@
 
 # Standard Library Cheatsheet
 
-Last updated: Mon, 30 Dec 2019 13:42:21 GMT
+Last updated: Mon, 30 Dec 2019 15:32:37 GMT
 
 
 ## Usage
@@ -64,14 +64,6 @@ Last updated: Mon, 30 Dec 2019 13:42:21 GMT
 
 | Wenyan | Javascript Equivalent |
 |---|---|
-| [`左移`](../lib/js/位經.wy#L1) | `x<<y` |
-| [`右移`](../lib/js/位經.wy#L6) | `x>>y` |
-| [`補零右移`](../lib/js/位經.wy#L11) | `x>>>y` |
-| [`位与`](../lib/js/位經.wy#L16) | `x&y` |
-| [`位或`](../lib/js/位經.wy#L21) | `x\|y` |
-| [`异或`](../lib/js/位經.wy#L26) | `x^y` |
-| [`与非`](../lib/js/位經.wy#L31) | `~(x&y)` |
-| [`位變`](../lib/js/位經.wy#L36) | `~x` |
 
 
 
@@ -82,7 +74,7 @@ This cheatsheet is generated direct from stdlibs. There are still a lot of funct
 
 Add comments in the stdlib files (one line above the function/value), the format should look like this:
 ```
-疏曰「「餘弦。同犀之Math.cos也。」」
+注曰「「餘弦。同Javascript之Math.cos也。」」
 ```
 
 After you fill the comments, you need to update the document by running

lib/算經.wy

@@ -163,31 +163,31 @@
 是謂「盤古」之術也。
 施「盤古」。
 
-疏曰「「圓周率。同犀之Math.PI也。」」
+注曰「「圓周率。同Javascript之Math.PI也。」」
 今有一數。曰「假圓周率」。名之曰「圓周率」。注曰「「圓周率者。三又一分四釐一毫有奇也。」」
 乘二於「圓周率」。名之曰「假倍圓周率」。
-疏曰「「倍圓周率。同犀之Math.PI * 2也。」」
+注曰「「倍圓周率。同Javascript之Math.PI * 2也。」」
 今有一數。曰「假倍圓周率」。名之曰「倍圓周率」。
 除二於「圓周率」。名之曰「假半圓周率」。
-疏曰「「半圓周率。同犀之Math.PI / 2也。」」
+注曰「「半圓周率。同Javascript之Math.PI / 2也。」」
 今有一數。曰「假半圓周率」。名之曰「半圓周率」。
 除四於「圓周率」。名之曰「假四分圓周率」。
-疏曰「「四分圓周率。同犀之Math.PI / 4也。」」
+注曰「「四分圓周率。同Javascript之Math.PI / 4也。」」
 今有一數。曰「假四分圓周率」。名之曰「四分圓周率」。
-疏曰「「自然常數。同犀之Math.E也。」」
+注曰「「自然常數。同Javascript之Math.E也。」」
 今有一數。曰「假自然常數」。名之曰「自然常數」。注曰「「自然常數者。二又七分一釐八毫有奇也。」」
-疏曰「「歐拉常數。同犀之0.5772156649015329也。」」
+注曰「「歐拉常數。同Javascript之0.5772156649015329也。」」
 今有一數。曰「假歐拉常數」。名之曰「歐拉常數」。注曰「「歐拉常數者。五分七釐七毫二絲有奇也。」」
-疏曰「「黃金分割數。同犀之1.618033988749895也。」」
+注曰「「黃金分割數。同Javascript之1.618033988749895也。」」
 今有一數。曰「假黃金分割數」。名之曰「黃金分割數」。注曰「「黃金分割數者。一又六分一釐八毫有奇也。」」
-疏曰「「二之平方根。同犀之Math.SQRT2也。」」
+注曰「「二之平方根。同Javascript之Math.SQRT2也。」」
 今有一數。曰「假二之平方根」。名之曰「二之平方根」。注曰「「二之平方根者。一又四分一釐四毫有奇也。」」
-疏曰「「二之對數。同犀之Math.LN2也。」」
+注曰「「二之對數。同Javascript之Math.LN2也。」」
 今有一數。曰「假二之對數」。名之曰「二之對數」。注曰「「二之對數者。六分九釐三毫一絲有奇也。」」
-疏曰「「十之對數。同犀之Math.LN10也。」」
+注曰「「十之對數。同Javascript之Math.LN10也。」」
 今有一數。曰「假十之對數」。名之曰「十之對數」。注曰「「十之對數者。二又三分零釐二毫有奇也。」」
 
-疏曰「「不可算數乎。同犀之Number.isNaN也。」」
+注曰「「不可算數乎。同Javascript之Number.isNaN也。」」
 今有一術。名之曰「不可算數乎」。欲行是術。必先得一數。曰「甲」。乃行是術曰。
 	若「甲」等於「甲」者。乃得陰。
 	若非。乃得陽也。
@@ -389,7 +389,7 @@
 	云云。
 是謂「求多項式」之術也。
 
-疏曰「「浮點移位。同犀之x * Math.pow(2, y), y is integer也。」」
+注曰「「浮點移位。同Javascript之x * Math.pow(2, y), y is integer也。」」
 今有一術。名之曰「浮點移位」。欲行是術。必先得二數。曰「本」。曰「位」。乃行是術曰。
 	注曰「「位正則進位。負則退位。」」
 	若「位」不大於「至大指」者。若「位」不小於「至小指」者。
@@ -425,7 +425,7 @@
 	云云。
 是謂「浮點移位」之術也。
 
-疏曰「「析浮點數。同犀之N/A也。」」
+注曰「「析浮點數。同Javascript之N/A也。」」
 今有一術。名之曰「析浮點數」。欲行是術。必先得一數。曰「甲」。乃行是術曰。
 	注曰「「是術得一物。物有三數。曰符。曰位。曰本。符者。正負也。位者。進退位也。本者。本數也。」」
 	注曰「「設計算機二進。若施是術於負六。乃得符負一。位二。本一又五分。」」
@@ -469,7 +469,7 @@
 	云云。
 是謂「析浮點數」之術也。
 
-疏曰「「正弦。同犀之Math.sin也。」」
+注曰「「正弦。同Javascript之Math.sin也。」」
 今有一術。名之曰「正弦」。欲行是術。必先得一數曰「甲」。乃行是術曰。
 	注曰「「數小甚矣。乃得其身。否則以泰勒展開求之。復以週期性得其餘。」」
 
@@ -499,15 +499,15 @@
 
 是謂「正弦」之術也。
 
-疏曰「「餘弦。同犀之Math.cos也。」」
+注曰「「餘弦。同Javascript之Math.cos也。」」
 今有一術。名之曰「餘弦」。欲行是術。必先得一數曰「甲」。乃行是術曰。
 	注曰「「餘弦者。蓋正弦之變化所得。」」
 
 	加「甲」以「半圓周率」。取一以施「正弦」。乃得矣。
 
 是謂「餘弦」之術也。
 
-疏曰「「反正弦。同犀之Math.asin也。」」
+注曰「「反正弦。同Javascript之Math.asin也。」」
 今有一術。名之曰「反正弦」。欲行是術。必先得一數曰「甲」。乃行是術曰。
 	注曰「「Abramowitz & Stegun 書中所述之法」」
 	若「甲」小於零者。
@@ -534,14 +534,14 @@
 
 是謂「反正弦」之術也。
 
-疏曰「「反餘弦。同犀之Math.acos也。」」
+注曰「「反餘弦。同Javascript之Math.acos也。」」
 今有一術。名之曰「反餘弦」。欲行是術。必先得一數曰「甲」。乃行是術曰。
 	注曰「「反餘弦者。蓋反正弦之變化所得。」」
 	減零以「甲」。取一以施「反正弦」。加其以「半圓周率」。乃得矣。
 
 是謂「反餘弦」之術也。
 
-疏曰「「正切。同犀之Math.tan也。」」
+注曰「「正切。同Javascript之Math.tan也。」」
 今有一術。名之曰「正切」。欲行是術。必先得一數曰「甲」。乃行是術曰。
 	注曰「「數小甚矣。乃得其身。居零與二十二度三十分之間者。以泰勒展開求之。其餘或以三角恆等式。或以週期性可得。」」
 
@@ -578,7 +578,7 @@
 
 是謂「正切」之術也。
 
-疏曰「「反正切。同犀之Math.atan也。」」
+注曰「「反正切。同Javascript之Math.atan也。」」
 今有一術。名之曰「反正切」。欲行是術。必先得一數曰「甲」。乃行是術曰。
 	注曰「「數小甚矣。乃得其身。小於二減根號三者。以泰勒展開求之。其餘以三角恆等式變化可得。」」
 
@@ -612,7 +612,7 @@
 是謂「反正切」之術也。
 
 
-疏曰「「勾股求角。同犀之Math.atan2也。」」
+注曰「「勾股求角。同Javascript之Math.atan2也。」」
 今有一術。名之曰「勾股求角」。欲行是術。必先得二數曰「甲」。曰「乙」。乃行是術曰。
 	注曰「「反正切之分類討論也」」
 
@@ -630,7 +630,7 @@
 是謂「勾股求角」之術也。
 
 
-疏曰「「勾股求弦。同犀之Math.hypot也。」」
+注曰「「勾股求弦。同Javascript之Math.hypot也。」」
 今有一術。名之曰「勾股求弦」。欲行是術。必先得二數曰「勾」。曰「股」。乃行是術曰。
 	施「絕對」於「勾」。名之曰「甲」。
 	施「絕對」於「股」。名之曰「乙」。
@@ -667,7 +667,7 @@
 	除一以十九。充「對數多項式甲」以其。
 注曰「「 x^2 * f(x^2) = atanh(x)/x - 1 」」
 
-疏曰「「對數。同犀之Math.log也。」」
+注曰「「對數。同Javascript之Math.log也。」」
 今有一術。名之曰「對數」。欲行是術。必先得一數曰「甲」。乃行是術曰。
 	注曰「「自然對數。」」
 	有爻陽。名之曰「非常」。
@@ -710,7 +710,7 @@
 	除負一千三百八十二以六億三千八百五十一萬二千八百七十五。充「指數多項式甲」以其。
 注曰「「 x^2 * f(x^2) = x/tanh(x) - 1 」」
 
-疏曰「「指數。同犀之Math.exp也。」」
+注曰「「指數。同Javascript之Math.exp也。」」
 今有一術。名之曰「指數」。欲行是術。必先得一數曰「甲」。乃行是術曰。
 	注曰「「自然指數。」」
 	有爻陽。名之曰「非常」。
@@ -746,7 +746,7 @@
 	施「浮點移位」於「庚」。於「移位數」。乃得矣。
 是謂「指數」之術也。
 
-疏曰「「冪。同犀之Math.pow也。」」
+注曰「「冪。同Javascript之Math.pow也。」」
 今有一術。名之曰「冪」。欲行是術。必先得二數。曰「底」。曰「指」。乃行是術曰。
 	注曰「「小數部借指數算之。整數部死算可矣。」」
 
@@ -770,7 +770,7 @@
 減一於「二之平方根」。乘其以二。名之曰「平方根常數乙」。
 乘「上位冪」於「微位冪」。乘其以「進制」。乘其以「進制」。名之曰「平方根下溢界」。
 
-疏曰「「平方根。同犀之Math.sqrt也。」」
+注曰「「平方根。同Javascript之Math.sqrt也。」」
 今有一術。名之曰「平方根」。欲行是術。必先得一數曰「甲」。乃行是術曰。
 	有爻陽。名之曰「非常」。
 	若「甲」不小於「平方根下溢界」者。若「甲」小於「巨位冪」者。
@@ -831,17 +831,17 @@
 	乃得「乙」。
 是謂「平方根」之術也。
 
-疏曰「「絕對。同犀之Math.abs也。」」
+注曰「「絕對。同Javascript之Math.abs也。」」
 今有一術。名之曰「絕對」。欲行是術。必先得一數。曰「甲」。乃行是術曰。
 	施「正負」於「甲」。名之曰「符」。乘「符」於「甲」。乃得矣。
 是謂「絕對」之術也。
 
-疏曰「「取頂。同犀之Math.ceil也。」」
+注曰「「取頂。同Javascript之Math.ceil也。」」
 今有一術。名之曰「取頂」。欲行是術。必先得一數。曰「甲」。乃行是術曰。
 	乘負一於「甲」。取一以施「取底」。乘其以負一。乃得矣。
 是謂「取頂」之術也。
 
-疏曰「「取底。同犀之Math.floor也。」」
+注曰「「取底。同Javascript之Math.floor也。」」
 今有一術。名之曰「取底」。欲行是術。必先得一數。曰「甲」。乃行是術曰。
 	施「正負」於「甲」。名之曰「符」。乘「符」於「甲」。名之曰「乙」。
 	注曰「「JavaScript者。除負以正。所餘負也。Python者。除負以正。所餘正也。」」
@@ -856,7 +856,7 @@
 		乃得「甲」也。
 是謂「取底」之術也。
 
-疏曰「「取整。同犀之Math.round, but rounded away from zero when the fractional part is exactly 0.5也。」」
+注曰「「取整。同Javascript之Math.round, but rounded away from zero when the fractional part is exactly 0.5也。」」
 今有一術。名之曰「取整」。欲行是術。必先得一數。曰「甲」。乃行是術曰。
 	施「正負」於「甲」。名之曰「符」。乘「符」於「甲」。名之曰「乙」。
 	除「乙」以一。所餘幾何。名之曰「丙」。
@@ -870,7 +870,7 @@
 		乃得「甲」也。
 是謂「取整」之術也。
 
-疏曰「「捨餘。同犀之Math.trunc也。」」
+注曰「「捨餘。同Javascript之Math.trunc也。」」
 今有一術。名之曰「捨餘」。欲行是術。必先得一數。曰「甲」。乃行是術曰。
 	施「正負」於「甲」。名之曰「符」。乘「符」於「甲」。名之曰「乙」。
 	除「乙」以一。所餘幾何。名之曰「丙」。
@@ -880,7 +880,7 @@
 		乃得「甲」也。
 是謂「捨餘」之術也。
 
-疏曰「「正負。同犀之Math.sign也。」」
+注曰「「正負。同Javascript之Math.sign也。」」
 今有一術。名之曰「正負」。欲行是術。必先得一數。曰「甲」。乃行是術曰。
 	若「甲」大於零者。乃得一也。
 	若「甲」小於零者。乃得負一也。

lib/籌經.wy

@@ -1,4 +1,4 @@
-疏曰「「求和。同犀之reduce((a,b)=>a+b)也。」」
+注曰「「求和。同Javascript之reduce((a,b)=>a+b)也。」」
 今有一術。名之曰「求和」。欲行是術。必先得一列。曰「列」。乃行是術曰。
 吾有一數。曰零。名之曰「和」。凡「列」中之「數」。加「和」以「數」。
 名之曰「和」。云云。乃得「和」。是謂「求和」之術也。

tools/stdlib_doc.js

@@ -6,7 +6,7 @@ const StdlibDocFilePath = path.resolve(
   __dirname,
   "../documentation/Standard-Lib.md"
 );
-const DocRegex = /疏曰「「(.+?)。同犀之(.+?)也。」」/g;
+const DocRegex = /注曰「「(.+?)。同Javascript之(.+?)也。」」/g;
 const GithubRoot = "..";
 
 const HEAD = `<!-- GENERATED FILE, DO NOT MODIFY-->
@@ -32,7 +32,7 @@ This cheatsheet is generated direct from stdlibs. There are still a lot of funct
 
 Add comments in the stdlib files (one line above the function/value), the format should look like this:
 \`\`\`
-疏曰「「餘弦。同犀之Math.cos也。」」
+注曰「「餘弦。同Javascript之Math.cos也。」」
 \`\`\`
 
 After you fill the comments, you need to update the document by running