Add comments for rules

ozzii · 2007-12-06 08:44

Hi,

I would like to know if it's possible to add the ability to add a comment for rules.
This can be very useful for fast reading RegEx rules for example (Thanks Stefan).

PS:
Or maybe the possibility to named rules. So we can see "RegEx(comment)" into the column "Rule".
Or another way it is to show a Tooltip when the cursor is over the rule.
(Choose the easier for you )

ozzii · 2007-12-06 18:40

For the RegEx rule I found this:

I put (?#comment) at the beginning of the expression
Now I have a commented RegEx rule.

den4b · 2008-01-05 19:34

Use PascalScipt rule to enter comments as rules.

You can use either of these commenting styles:

{ comments }
// comments
(* comments *)

Just put this into the code window.

krtek · 2008-02-23 09:19

I also do miss the comment/description field for every rule. I know the hint with empty pascal script as the comment, but that's not the same.
I can't explain why, but having description in the same line as rule is better.
Maybe because you don't have to read everything to find out which line is a rule, and which is just a description - you just look at the description column and you see straight away to which rules there are comments...
It would be great for me if there where one more column in the rule part of ReNamer window - the "description" column. I think its not hard to implement, as it could be optional Comment= line (after Marked=) in preset file.

And it would be very nice to have a possibility to choose which columns in rule part of window should be shown (as it is in file part of window). Then I could leave eg. only Tick box (*) and Description column which could be much more informative than Rule and Statement columns.

den4b · 2008-02-24 14:04

Sorry, but I find it to be an overkill with the custom description and configurable columns for the rules table.

This is not just about adding the "Comment=" line in the preset, this will require a lot of work as the integration will have to applied application-wise, not just in the preset. And then, it would all have to be tested for integrity. The same applies to the configurable columns, because I would have to completely change the component for the rules table and the ways at which data is stored and manipulated.

I'm not saying "it is impossible", but effort is much greater than benefits. I hope you'll understand.

It always sounds easier from user's point of view

krtek · 2008-02-28 15:41

You're right. Now I see it's much harder than I thought But maybe someday
Keep working on really important things.
Thanks again for this great tool.

Last edited by krtek (2008-02-28 15:42)

den4b · 2018-06-24 23:54

Rule comments have been implemented in ReNamer 6.8.0.4 Beta.

- You can add/edit rule comments via the rules context menu, or using a Shift+Enter hotkey.
- Comments are displayed in the Statement column, replacing the auto-generated rule description, when available.

den4b Forum

#1 2007-12-06 08:44

Add comments for rules

#2 2007-12-06 18:40

Re: Add comments for rules

#3 2008-01-05 19:34

Re: Add comments for rules

#4 2008-02-23 09:19

Re: Add comments for rules

#5 2008-02-24 14:04

Re: Add comments for rules

#6 2008-02-28 15:41

Re: Add comments for rules

#7 2018-06-24 23:54

Re: Add comments for rules

Board footer