17 Apr
2018
17 Apr
'18
10:32 a.m.
When I need to write code that I don't want to be seen as public API, I put
it in the internal package (that's the definition).
Now, if I have a lot of code that I want to keep internal, I create
sub-packages under that "internal" package.
Because sometimes, it doesn't make any sense to create dozens of empty
packages just to have an "internal" package at the deeper level that
actually have code.
Thanks
2018-04-16 18:28 GMT+02:00 Vincent Massol <vincent(a)massol.net>et>:
Hi devs,
On Matrix/IRC, I’ve posted the following:
"
* Guillaume Delhumeau: BTW your naming is strange for the internal package
* for ex: package org.xwiki.notifications.preferences.internal.email;
* normally we put internal just after the main package part
* ie.
* org.xwiki.notifications.internal.*
* and org.xwiki.notifications.* for public classes
* see http://dev.xwiki.org/xwiki/bin/view/Community/CodeStyle/
JavaCodeStyle/#HPackagenames
* General rule is org.xwiki.(module name).internal.
* I see thomas has done the same “error" for
org.xwiki.job.handler.internal and org.xwiki.job.handler.internal.question
. So maybe there's something to discuss/change
* I guess we have a mix of both now so we should discuss it and adjust our
rules if need be
“
So I think we don’t have all the same rules/understanding of the
definition at http://dev.xwiki.org/xwiki/bin/view/Community/CodeStyle/
JavaCodeStyle/#HPackagenames
I’d like to discuss with you to see what you prefer and adjust our rules
so that it matches what we do in practice.
Any take in this?
Thanks
-Vincent
--
Guillaume Delhumeau (guillaume.delhumeau(a)xwiki.com)
Research & Development Engineer at XWiki SAS
Committer on the XWiki.org project