Hi,
I agree we need to setup some rules (thats why I answer with a new
subject line). However, I start here by simply answering on your 4 notes:
I noticed that we miss some policies to keep code consistent :
- internationalized strings are not always declared the same way (in
last plugins, they seem to be initialized as static class attributes,
then again in the plugin initializer. I'm not sure what the best
practise should be
I am often applying a re-setting in the initialize method, since this
allows loading the language at runtime. It ensures that when the (old)
language property is used, the correct language is loaded.
I'm aware that static initialization is not enough because it happens
sometimes too early.
I don't remember if static initialization is useful at all if string is
initialized in the initialize method.
- menu items opening a dialog box should end by ... Sometimes, the
ellipse is added by the plugin itself, sometimes it is included in the
properties file (I'd rather first solution is better)
yep.. I often forgot about this specification
In my recent additions I have added +"..." directly to the plugin name
in the plugin class - so not in the properties files. I think this is
the best option.
That's ok. I think I've not been consistent in my previous plugins.
I'll add ellipses in the plugin's name for those still missing in the UI.
- every enableCheck String is defined 2 times in the properties file.
One time with a short key and a {0} in the key and the other time with a
complete key and no {} in the key. I did not check which one is mostly
used in the source.
Oh.. I haven't realized this. Although I noticed that we have these
curly brackets. But I am not sure what is the sense of those.
Brackets in the localized string are replaced by formatted objects (if
I18N.getMessage() is used).
I just learnt about this today. I think curly braces in the key part are
a little bit confusing as they have no special meaning.
It seems that the version starting with "plugin.EnableCheckFactory" and
using curly braces is never used in the sources, whilst the version with
com.vividsolutions.jump.workbench and no curly braces is rarely used
(and mainly in the EnableCheckFactory class)
- we should avoid accented character in the source...
yes.. I hope I didn't use them
About 100 lines concerned. Mainly french ;-(
I'll try to translate comments, and I'll check if html entities can be
used for javadoc
Michaël
stefan
...
I'm not the best expert to write a guideline, but I can try to start it
so that we can discuss about the best practises.
Michaël
stefan
------------------------------------------------------------------------------
Open Source Business Conference (OSBC), March 24-25, 2009, San Francisco, CA
-OSBC tackles the biggest issue in open source: Open Sourcing the Enterprise
-Strategies to boost innovation and cut costs with open source participation
-Receive a $600 discount off the registration fee with the source code: SFAD
http://p.sf.net/sfu/XcvMzF8H
_______________________________________________
Jump-pilot-devel mailing list
Jump-pilot-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/jump-pilot-devel
------------------------------------------------------------------------------
Open Source Business Conference (OSBC), March 24-25, 2009, San Francisco, CA
-OSBC tackles the biggest issue in open source: Open Sourcing the Enterprise
-Strategies to boost innovation and cut costs with open source participation
-Receive a $600 discount off the registration fee with the source code: SFAD
http://p.sf.net/sfu/XcvMzF8H
_______________________________________________
Jump-pilot-devel mailing list
Jump-pilot-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/jump-pilot-devel
------------------------------------------------------------------------------
Open Source Business Conference (OSBC), March 24-25, 2009, San Francisco, CA
-OSBC tackles the biggest issue in open source: Open Sourcing the Enterprise
-Strategies to boost innovation and cut costs with open source participation
-Receive a $600 discount off the registration fee with the source code: SFAD
http://p.sf.net/sfu/XcvMzF8H
_______________________________________________
Jump-pilot-devel mailing list
Jump-pilot-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/jump-pilot-devel
------------------------------------------------------------------------------
Open Source Business Conference (OSBC), March 24-25, 2009, San Francisco, CA
-OSBC tackles the biggest issue in open source: Open Sourcing the Enterprise
-Strategies to boost innovation and cut costs with open source participation
-Receive a $600 discount off the registration fee with the source code: SFAD
http://p.sf.net/sfu/XcvMzF8H
_______________________________________________
Jump-pilot-devel mailing list
Jump-pilot-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/jump-pilot-devel
