feat: compiled comments

[MagentaDude]

Currently, in goboscript, comments are removed at compile time, similar to other languages. However, since Scratch has a built-in comment feature, it would be nice to let users generate their own comments automatically.
Comments using # would still be ignored when compiling; but two hashes in a row ## would be used for these compiled comments. For example:

Ignored comment:
move 10; # todo: let the user choose how much to move by?

Compiled comment:
proc draw_image input { ## Draws an image.

[linear]

GS-286

[faretek1]

imo a syntax like ## would be better since it would mean that we dont make -- unusable, kind of like how rust has // and ///

[redspacecat]

Are there any plans for this? This would be super useful

[aspizu]

yes i do want to add this, but before this, we would need "clean up" code output instead of putting every script at 0,0

[slyi]

yes i do want to add this, but before this, we would need "clean up" code output instead of putting every script at 0,0

Could we use XML Documentation Comment standard for xy positioning of the proc's. In my last project vectorSector I converted inline comments to proc calls so the comments import into sb3 but I needed to remove proc _c comment {} in the sb3 afterwards to so it proc calls became a null reference, so the comments stayed visible in editor but not effect runtime performance.

[faretek1]

yes i do want to add this, but before this, we would need "clean up" code output instead of putting every script at 0,0

wouldnt calculating block positions (correctly) be quite expensive? unless you just place the head of each script just regularly 100pixels to the right each time or something. if you want a program to actually calculate the block positions, it should really be done externally

[aspizu]

awesome lmao has made a script in python and its actually not that complex

[redspacecat]

I usually just use TurboWarp/Scratch's right click > clean up blocks to arrange the compiled code, although it can be laggy if there's, say, 5,000 blocks being rendered in one spot, so an automatic version of that could be useful.

yes i do want to add this, but before this, we would need "clean up" code output instead of putting every script at 0,0

Why would this be necessary for adding code comments? When I add a comment in the editor and then do "clean up blocks" in TurboWarp the comment follows along correctly.

[MagentaDude]

yes i do want to add this, but before this, we would need "clean up" code output instead of putting every script at 0,0

That would be cool. You could also add a feature that if there are multiple newlines between scripts instead of just one (or if code is included with the preprocessor), it is put on the next column, like in Turbowarp clean up blocks+.

proc my_proc {
   say "Hi there!";
}

proc useless_proc {
   say "This is not used, but it's still on the same column";
}


onflag {
   say "This script is on the next column";
   wait 1;
   my_proc;
}

[redspacecat]

That would be cool. You could also add a feature that if there are multiple newlines between scripts instead of just one (or if code is included with the preprocessor), it is put on the next column, like in Turbowarp clean up blocks+.

I add multiple newlines sometimes for readability, and I would not want a feature that puts them in separate columns just because of that.
If that does exist it should be optional.

[MagentaDude]

That would be cool. You could also add a feature that if there are multiple newlines between scripts instead of just one (or if code is included with the preprocessor), it is put on the next column, like in Turbowarp clean up blocks+.

I add multiple newlines sometimes for readability, and I would not want a feature that puts them in separate columns just because of that. If that does exist it should be optional.

Maybe ### in a line could be used instead