two minor comment handling changes

[JdGordon]

very simple patch changes 2 skin behaviours... asking you lot whether it should be commited or not...
the first change is to fix bug #9640... What it does it #comments in the middle of lines eats everything but leaves the new line there, #comments at the beginning of a line eats the whole line (line ending included)

so this code:

Code: [Select]

mary # had
# a little
lamblooks like

Code: [Select]

mary
lamb(in svn it would be "mary lamb" on one line





the second part of the patch lets you easily split long lines by putting % as the last character of the line, so

Code: [Select]

once apon %
a timebecomes "once apon a time" on one line.



so tell me what you think... I dont actually fiddle with skin code at all so don't know how useful this will all be

[audio-i]

# comment fix: in my opinion nice (but not really that much critical?)

ability to split lines: I think in some cases using % for this could make WPS's hard to follow

Note: not that I would have voted like that, but perhaps the voting option "# comment fix AND opt3 but the character needs to be something else (which?)" should also be there?

[robin0800]

I like opt 3 and would like to see this character used "¬" I have seen this in publications to indicate split lines

[psycho_maniac]

opt3 but what if we used the + symbol?

[JdGordon]

I used % to split lines because that is the standard "escape" character in the skins... the other possibilities I like are \ and just # as the last char, but that could be confusing...

[BdN3504]

i wouldn't commit the weather. but i'd go with %. good idea to introduce this behaviour (both parts).

[Llorean]

I'd say the symbol needs to be something that appears in common keyboard layouts. Personally I'm fond of "\" as it's used in a lot of other cases. % also works, but as it's the standard escape character I have a few doubts about it. I really don't like using # as a line end (though I guess technically, that's how it works now).

I'm not entirely sure the first part even needs to be fixed (honestly, I'm surprised we allow mid-line comments, but it seems to me the current method of doing it, even if it will catch people by surprise the first time it happens, is actually slightly more flexible overall once you know it exists).

[gevaerts]

% also works, but as it's the standard escape character I have a few doubts about it.

It being the standard escape character is what makes this the logical choice. Any other character would need some way of specifying that it shouldn't trigger a continuation line.

[JdGordon]

% is the current escape char is the best reason to use it....

I think there is a flaw in the #comment at the end of the line eating the \n though... I think it shouldnt eat it if the line still ends in % (or whatever char we decide on) so you can still break up long lines, and comment on the same line instead of above or below the code

What are your doubts about %?

I get the impression that alot of people dont put comments in their wps which makes debugging and understanding very hard... I'm trying to make it easier (and so hopefully get more people to add them)

[Angus_NB]

Some programming languages, Visual Basic, VBA, use the _ character.
My opinion, % is used so much within the WPS code that it would be confusing to also use it within comments.

Over 100 views but only 10 of us voted.

[gevaerts]

Some programming languages, Visual Basic, VBA, use the _ character.

And what if you want a literal '_' character at the end of a line?

[JdGordon]

% works so easily because there is already special handling for it... if you want a % symbol on the wps you have to put %% in the code.... so % by itself is already understood to be special

[pixelma]

I just want to point out that the current behaviour of # is there on purpose (I think Llorean was thinking along those lines too).

This way you can add comments on separate lines without adding blank lines - this was needed as long as positioning text was purely line based and still has advantage if you do not position the text using a viewport or want to comment "inside" a viewport. I guess quite a few people will be surprised if their WPS looks differently if you change the behaviour as now every comment line starting with an # would add a blank line.

So a WPS with a code like this:

Code: [Select]

%ia
# show next track info below
%Ia

will then look like this:

Code: [Select]

current track's artist

next track's artist
You can easily avoid the "problem" with inline comment by not using them - I find them harder to read anyways. At the same time the current behaviour of # already offers you a way to break too long lines (without any need for a new marker character) - by using # at the end of your line.

[JdGordon]

That code snippet is what I'd like to discourage... the same could (and imo *should*) be done using blank lines... using comment lines makes it harder to read.

The second bit (using # to break lines) is supposedly a bug... I'm open to not fixing that

[JdGordon]

ok, after going back and forwards of being confused I've decided the % thing is wrong how I did it.... you shold be using #comment to break those lines....