On 15.06.2007, at 14:38, Oliver Lietz wrote:
At first I was confused about the names:
Content --> Node
NodeData --> Property
I had chosen MgnlNode and MgnlProperty as names for the wrapper
classes, in my
opinion more self-explanatory.
[...]
- use singular form for package names: servlet instead of servlets
- use Base prefix instead of Simple, Default, etc prefix and Impl
suffix, make
it consistent: BaseControl instead of ControlImpl...
AbstractExpressionImpl ;) - this one gets beaten only by openwfe.org.*
- use common Java naming scheme for classes: EditDialog instead of
DialogEdit
and EditBar instead of BarEdit
- use either Mgnl or Magnolia as prefix, not both
- cache and mail are modules but don't live in a module package
namespace like
other modules
- control, controlx...
- two interfaces with name Control in related context: one from
control, other
from controlx
- the use of core and cms is not obvious, move filters and servlets to
info.magnolia.web.*
- manager classes in package .beans.config, create a business or
manager
package
- beans.runtime... runtime?
I know that it's not always easy to keep a growing application
consistent and
find proper names, but sorry - I'm a qualified Bürokaufmann - it's
in my
nature...
I think these ideas should be documented in a jira issue. 3.1 is
doing a lot of cleanup in many ways. The current decision is to stick
with the API as much as possible. But cleaning up the names is always
worth doing.
There should be a maven plugin that checks API method name and module
name changes in SVN commits and creates change scripts for execution
against existing projects out there. This would allow us to cleanup
as much as we like with the security that all you need to do is run a
script and your code is up to date again. I should add it to
wishdom.de ;-)
- Boris
----------------------------------------------------------------
for list details see
http://documentation.magnolia.info/docs/en/editor/stayupdated.html
----------------------------------------------------------------
