22
comment style that tells text editors to fold sections of text
(programming.dev)
I noticed that the developer of kitty terminal uses this style of comments I have rarely if ever seen elsewhere:
outside
#: section {{{
inside
#: }}}
Kate text editor recognize sections for purposes of highlighting, folding etc. It's really nice for me because I sometimes I have a difficult time navigating large text files. And it lets you nest them.
- what is this called?
- are there other ways to do it?
- is it standard among text editors? I believe Kovid the dev for
kittyis avimguy so presumably there is support there also. - why don't more people use it? are there problems?
Screenshot that shows the code folding.
- Cursor is at the end of line 7 so the whole section line 7-22 is highlighted
- lines 12-16 are folded in a 3rd level comment
- I also included tab indents just to make it easier to see what's going on (Kate treats it the same way regardless of indents)
- Highlighting/Mode > Scripts > Bash
I also like his style of distinguishing between narrative comments (starting with #:) and commented-out code (starting with #). Although in my example, Kate doesn't treat them differently. Is there a term for this? Any conventions, support etc?
plain text used for screenshot
#: Comment level 1 {{{
#: Comment level 2 {{{
#: configure something
key value
#: }}}
#: Another Comment level 2 {{{
#: Comment level 3 {{{
#: Helpful explanatory comment
file location
#: }}}
#: Comment level 3 with hidden text {{{
you_cant see_this
hidden_emoji "๐๏ธ"
hidden_emoji2 " ๐๏ธ"
hidden_emoji3 " ๐๏ธ"
#: }}}
#: let's set some things up
# setting yes
# other_setting no
different_setting maybe
#: }}}
# regular comment
#: }}}
# regular comment outside anything
For a real world example, see sample kitty.conf file provided on project website.
Marker-based folding
Thanks! Searching for this led me to this extremely charming website where in addition to robust folding, the author argues in favor of proportional width fonts and tabstops (not spaces) in coding. Unconventional. It's nice to know someone who processes text in a similar way to me can be a successful programmer. Even if they had to write their own tools. https://tibleiz.net/code-browser/elastic-tabstops.html
BTW, my personal note about the tabstops for indentation is, I wish everyone would use it over spaces. Because it would make it much easier to display the file differently without changing it. Also parsing it would make it easier too probably. But since spaces are the standard, I exclusively use space for indentation.
I actually think the argument for mixing tabs and spaces makes a lot of sense. Use tabs for indentation, coupled with spaces for alignment (e.g. of function arguments). It eliminates the downsides of using tabs resp. spaces exclusively. But since nobody uses it, I never have either. Following the style of the project at hand is the way.
You mean alignment of arguments or multiline strings in example? If they are not on their own line, then it does not matter to me. If they start on their own line, then mixing spaces and tabs isn't a good idea to me. In example for function calls with a bit more complex calls and multiple arguments, I put them in their own line each. They are indented and therefore indentation level plays. If they are on the same line, I never align them and if I would, it would be spaces. In general:
I am very rarely working in other people's stuff because I am too rudimentary but of course I try to follow their rules when I do.
For my own purposes, I would do it in one of the below ways. I made the case more complicated by changing the lengths. I mostly choose consistent levels of indentation using tabs over per-character alignment but not always.
[--]= tab,~= single space (and double space = double space in front of comments for legibility here)Kate has a great feature called "insert smart newline" which I shortcut to
shift+enter. If you are typing for example on the penultimate line above and "insert smart newline" it'll automatically fill the line with[--][--]~~~~~ #:and put the cursor at the end. This feature really enables a lot of these habits for better or worse.When I write output to terminal I really like being able to use
tabsto modify the length of tabs according to what is the content. Sometimes I wish I could settabsin my editor (like a word processor), it would make things simpler. But then there's portability issues for non standard features like that so.