Comments
The general division of comments is into:
- "Texcomment"
- "Codcomment"
"Texcomment" represent a text that explains how the code works.
"Codcomment" is actually the code that was converted to comment,
and is used when testing a piece of code in a program.
The main division of comments is into:
- "Lincomment"
- "Blocomment"
All comments are divided into:
"Lincomments":
1) "Lefcomment"
2) "Righcomment"
3) "Widcomment"
"Blocomments":
4) "Lefblocomment"
5) "Righblocomment"
6) "Midblocomment"
7) "Parcomment"
8) "Widblocomment"
Comment consist of:
- "Commentag/s"
- "Commentcon"
All "Commentags" are divided into:
1) "Lefcommentag" <#
2) "Righcommentag" #>
3) "Widcommentag" <#>
4) "Lefblocommentags" \# /#
5) "Righblocommentags" #/ #\
6) "Midblocommentags" #< >#
7) "Parcommentags" ## ##
8) "Widblocommentags" \#/ /#\
Righcomment
"Righcomment":
* is a single-line comment.
* use "Righcommentag" #>
There must be at least one left and right space around the "Righcommentag" #>
unless it is at the beginning of a line where a left space is not necessary.
"Commentcon" is to the right of the "Righcommentag".
#> "Commentcon"
x = 0 #> "Righcomment" #> "Righcomment", also "Texcomment" y = 1 #> ############ "Righcomment", also "Texcomment" z = 8 #> ###### "Righcomment", also "Texcomment" #> z = 8 "Righcomment", also "Codcomment" #> sum(5 + 3) ---------------||--------------- #> x = 0 #> y = 1 #> z = 8
z = 2 #>this is NOT a "Righcomment" a = 3 this#> is NOT a ----||----- b = 4 this#>is NOT a ----||----- #>This is NOT a "Righcomment" c = 5
Lefcomment
"Lefcomment":
* is a single-line comment.
* use "Lefcommentag" <#
The code can be found to the right of the "Lefcommentag".
There must be at least one left and right space around the "Lefcommentag" <#
unless it is at the beginning of a line where a left space is not necessary.
"Commentcon" is to the left of the "Lefcommentag".
"Commentcon" <#
"Commentcon" <# code = "comes here" some "Lefcomment" bla bla bla bla bla bla bla bla <# x = 0 next "Lefcomment" also "Texcomment" bla bla bla <# y = 1 -----------------------||------------------------ <# z = 2 another "Lefcomment" <# a = 10 x = 0 "Lefcomment", also "Codcomment" <# y = 1 ---------------||-------------- <# z = 2 ---------------||-------------- <# x = 0 <# y = 1 <# z = 2 <#
this is NOT "Lefcomment"<# b = 12 this is NOT "Lefcomment"<#c = 18
Widcomment
"Widcomment":
* is a single-line comment.
* use "Widcommentag" <#>
"Widcomment" converts the entire line of code into a comment.
The code can be found above or below the "Widcommentag".
There must be at least one left and right space around the "Widcommentag" <#>
unless it is at the beginning of a line where a left space is not necessary.
"Widcommentag" is between of the "Commentcons".
"Commentcon" <#> "Commentcon"
"Commentcon" <#> "Commentcon" some_above1 = "code can be found here" some_above2 = "code can be found here" "Widcomment" part <#> "Widcomment" part some_below1 = "code can be found here" some_below2 = "code can be found here"
x = 0 y = 2 z = 5 <#> z = 7 .sum x y z <#> avg(x y z) .sum x y
this is NOT "Widcomment"<#> b = 12 this is NOT "Widcomment" <#>c= 18
Lefblocomment
"Lefblocomment":
* is a multi-line comment,
* use opening and closing "Lefblocommentags" \# /#
* is most commonly used to convert the code into a comment
without moving the code to any side (left or right, up or down).
"Lefblocomment" replaces multiple individual "Lefcomments".
There must be at least one left and right space around the opening and closing "Lefblocommentags" \# /#
unless they are at the beginning of a line where a left space is not necessary.
The right vertical border of this comment is at the outermost "Lefblocommentag".
"Commentcon" is to the left of the opening and closing "Lefblocommentags",
and also vertically between the two ("Lefblocommentags").
The code can be found to the right of the "Lefblocommentags",
and on the right side of the imaginary vertical border of "Lefblocommentags".
"Commentcon" \# code1 = "can comes here" -----||----- code2 = "can comes here" -----||----- /# code3 = "can comes here" "Commentcon" \# code1 = "can comes here" -----||----- code2 = "can comes here" -----||----- and some stuff /# code3 = "can comes here" "Lefblocomment" part \# x = 0 ---------||--------- y = 1 ---------||--------- z = 2 ---------||--------- /# .sum x y z
#> Example below shows ERROR, #> because var "c" of the code (.sum a b c) is located right next to #> the imaginary vertical border of "Lefblocommentags". #> Code (.sum a b ) represents a comment. NOT "Lefblocomment" part, ERROR \# a = 0 ---------||-------------------- b = 1 ---------||-------------------- c = 2 ---------||------ /# .sum a b c
#> example below shows the unmoving commented code from its original location.
#> "Lefblocomment", also "Codcomment"
x = 0 \#
y = 1
z = 2
.sum x y z /#
Righblocomment
"Righblocomment":
* is a multi-line comment,
* use opening and closing "Righblocommentags" #/ #\
* is most commonly used to describe the code on the left,
replaces multiple individual "Righcomments".
There must be at least one left and right space around the opening and closing "Righblocommentags" #/ #\
unless they are at the beginning of a line where a left space is not necessary.
The left vertical border of this comment is closest to the beginning of the code line.
"Commentcon" is to the right of the opening and closing "Righblocommentags",
and also vertically between the two ("Righblocommentags").
The code can be found to the left of the "Righblocommentags",
and on the left side of the imaginary vertical border of "Lefblocommentags".
code1 = "can comes here" #/ "Commentcon" code2 = "can comes here" -----||----- code3 = "can comes here" #\ -----||----- x = 0 #/ "Righblocomment" part y = 1 ----------||--------- z = 2 ----------||--------- .sum x y z #\ ----------||---------
#> example below shows ERROR, #> because var "c" of the code (.sum a b c) is located left next to #> the imaginary vertical border of "Righblocommentags". #> Code (.sum a b ) represents the code itself. a = 0 #/ "Righblocomment" part ERROR b = 1 ---------||---------------- c = 2 ---------||---------------- .sum a b c #\ ---------||----------------
#> example below shows another variant of "Codcomment" located on the right #> "Righblocomment", also "Codcomment" x = 0 #/ x = 3 y = 1 y = 5 z = 2 z = 9 .sum x y z #\ .avg x y z
Midblocomment
"Midblocomment":
* is a single-line comment, and multi-line comment.
* use opening and closing "Midblocommentags" #< >#
* is most commonly used to describe the code on both sides.
There must be at least one left and right space around the opening and closing "Midblocommentags" #< >#
unless they are at the beginning of a line where a left space is not necessary.
"Commentcon" is located between both "Midblocommentags" across the width.
#< "Commentcon" >#
The code can be found to the left and right of the "Midblocommentags",
and on the left and right side of the imaginary vertical border of "Midblocommentags".
#< This is a "Midblocomment" >#
#< This is a "Midblocomment" in one line >#
#< This is a "Midblocomment" in one line >#
#< "Midblocomment" in multiple lines
-------------||------------------
-------------||------------------
-------------||------------------
-------------||------------------ >#
#> The example below shows the code #> to the left and right of the "Midblocomment" x = 2 #< "Midblocomment" in multiple lines ;; x = 1 y = 5 -------------||------------------ ;; y = 3 z = 9 -------------||------------------ ;; z = 8 -------------||------------------ .sum x y z -------------||------------------ ># ;; .avg x y z
#<This is NOT a "Midblocomment" >#
#< This is NOT a "Midblocomment">#
#<This is NOT a "Midblocomment">#
#< This is NOT a "Midblocomment", ERROR
----------||------------------------
----------||------------------------
because second "Midblocommentag"
must not be in the same column,
but to the right in the column of
the widest row of "Midblocomment".
>#
Parcomment
"Parcomment":
* is a single-line comment, and multi-line comment.
* use the same opening and closing "Parcommentags" ## ##
* similarly behaves like a paragraph of text, but it is not a "Docstring".
* is most commonly used to indentedly describe some definition.
There must be at least one left and right space around the opening and closing "Parcommentags" ## ##
unless they are at the beginning of a line where a left space is not necessary.
"Commentcon" is located between both "Parcommentags".
## "Commentcon" ##
The code can be in the same line to the left of the opening "Parcommentag" or above it,
and it can also be in the same line to the right of the closing "Parcommentag" or below it.
## This is a "Parcomment" ##
## This is a "Parcomment" in one line ##
## This is a "Parcomment" in one line ##
## This is a "Parcomment"
##
## This is a "Parcomment"
bla bla bla ##
## This is a "Parcomment"
bla bla bla
##
##
This is a "Parcomment"
bla bla bla
##
##
This is a "Parcomment"
bla bla bla
##
##
This is a "Parcomment"
bla bla bla
##
##
This is a "Parcomment"
bla bla bla bla bla bla bla bla bla
##
##This is NOT a "Parcomment" ##
## This is NOT a "Parcomment"##
##This is NOT a "Parcomment"##
Widblocomment
"Widblocomment":
* is a multi-line comment.
* use opening and closing "Widblocommentags" \#/ /#\
* is used to comment on left and right code variants.
There must be at least one left and right space around the opening and closing "Widblocommentags" \#/ /#\
unless it is at the beginning of a line where a left space is not necessary.
"Commentcons" are to the left and right of both "Widblocommentags".
Both "Widblocommentags" do not need to be in the same vertical column.
"Commentcon" \#/ "Commentcon"
"Commentcon" /#\ "Commentcon"
"Commentcon" \#/ "Commentcon"
"Commentcon" /#\ "Commentcon"
"Widblocomment" part \#/ "Widblocomment" part
-------||----------- -------||-----------
-------||----------- -------||-----------
-------||----------- -------||-----------
-------||----------- -------||-----------
-------||----------- /#\ -------||-----------
#> "Widblocommentags" don't need to be in the same vertical colorn
"Widblocomment" part \#/ "Widblocomment" part
-------||----------- -------||-----------
-------||----------- -------||-----------
-------||----------- -------||-----------
-------||----------- -------||-----------
-------||-------- /#\ -------||-----------
#> all code is comment (left and right)
x = 0 \#/ x = 1
y = 2 y = 3
z = 5 z = 8
.sum x y z /#\ .avg x y z
Combo Comments
It is possible to combine all types of comments and codes.
"Combo Comments" is a must, Developer's paradise at last. ;)
"Lefcomment" <# x = 5 #> "Righcomment" -----||----- <# y = 8 #> -----||------ -----||----- <# sum(x y) #> -----||------
"Lefblocomment" part \# x = 5 #/ "Righblocomment" part ---------||--------- y = 8 ----------||--------- ---------||--------- /# sum(x y) #\ ----------||---------
"Lefcomment" <# a = 5 #< "Midblocomment" ># ;; z = 8 #> "Righcomment" -----||----- <# b = 5 #< ------||------- ># ;; x = 8 #> -----||------ -----||----- <# c = 5 #< ------||------- ># ;; y = 8 #> -----||------ -----||----- <# d = "code" #< ------||------- ># ;; g = t = 100 #> -----||------ -----||----- <# sum(a b) #< ------||------- ># ;; min(z x y) #> -----||------ -----||----- <# avg(a b c) #< ------||------- ># ;; .max z x y #> -----||------ -----||----- <# .upper d #< ------||------- ># ;; (z x y)..max() #> -----||------ "Lefcomment" <# a = 5 #< "Midblocomment" ;; z = 8 #> "Righcomment" -----||----- <# b = 5 ------||------- ;; x = 8 #> -----||------ -----||----- <# c = 5 ------||------- ;; y = 8 #> -----||------ -----||----- <# d = "code" ------||------- ;; g = t = 100 #> -----||------ -----||----- <# sum(a b) ------||------- ;; min(z x y) #> -----||------ -----||----- <# avg(a b c) ------||------- ;; .max z x y #> -----||------ -----||----- <# .upper d ------||------- ># ;; (z x y)..max() #> -----||------
"Lefblocomment" \# a = 5 #< "Midblocomment" ># ;; z = 8 #/ "Righblocomment" ------||------- b = 5 #< ------||------- ># ;; x = 8 -------||------- ------||------- c = 5 #< ------||------- ># ;; y = 8 -------||------- ------||------- d = "code" #< ------||------- ># ;; g = t = 100 -------||------- ------||------- sum(a b) #< ------||------- ># ;; min(z x y) -------||------- ------||------- avg(a b c) #< ------||------- ># ;; .max z x y -------||------- ------||------- /# .upper d #< ------||------- ># ;; (z x y)..max() #\ -------||------- "Lefblocomment" \# a = 5 #< "Midblocomment" ;; z = 8 #/ "Righblocomment" ------||------- b = 5 ------||------- ;; x = 8 -------||------- ------||------- c = 5 ------||------- ;; y = 8 -------||------- ------||------- d = "code" ------||------- ;; g = t = 100 -------||------- ------||------- sum(a b) ------||------- ;; min(z x y) -------||------- ------||------- avg(a b c) ------||------- ;; .max z x y -------||------- ------||------- /# .upper d ------||------- ># ;; (z x y)..max() #\ -------||-------
##
This is a "Parcomment".
In example below, everything is "Widblocomment" because of the "Widblocommentags" \#/ /#\
##
"Widblocomment" 1/7 \# a = 5 #< "Widblocomment" ;; z = 8 \#/ "Widblocomment" 1/7
------||------- 2/7 b = 5 ------||------- ;; x = 8 -------||------- 2/7
------||------- 3/7 c = 5 ------||------- ;; y = 8 -------||------- 3/7
------||------- 4/7 d = "code" ------||------- ;; g = t = 100 -------||------- 4/7
------||------- 5/7 sum(a b) ------||------- ;; min(z x y) -------||------- 5/7
------||------- 6/7 avg(a b c) ------||------- ;; .max z x y -------||------- 6/7
------||------- 7/7 /# .upper d ------||------- ># ;; (z x y)..max() /#\ -------||------- 7/7