You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by "J.Pietschmann" <j3...@yahoo.de> on 2003/09/26 21:57:21 UTC
[math] Maven build and elements of style
Hi,
is there a way to tell maven not to reload the three SNAPSHOT
jars without secifying "--offline" (which may cause failure
due to other missing jars)?
Could we use release jars instead of snapshots?
Further notices:
There are a few FIXME comments. I've configured my Eclipse to
mark FIXMEs, but the out-of-the-box config highlights only TODOs.
Can we agree on a common style here?
I also get a lot of checkstyle warnings for operators placed at
the beginning of a line. This is both Old Emacs style as well as
Eclipse's auto formatting style. I have no idea how the Eclipse
auto formatter can be told to put the operators at the end of
the line. Also, I personally find operators at the end of the line
awful too, although it is more consistent with common line breaking
rules in documents.
Questions: where's the "operator at previous line end" originating?
Are there IDEs/formatters which auto-format operators at the end
of the previous line?
Can/should we revert to "operator at the beginning of the line"?
Is there some way to order JavaDoc to tell the correct line for its
warnings? I get them consistently wrong, by an unpredictable amount.
J.Pietschmann
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [math] Maven build and elements of style
Posted by "Mark R. Diggory" <md...@latte.harvard.edu>.
Now in hindsight, you may be correct concerning this.
From my understanding, Maven will resolve SNAPSHOTS to thier proper
build number when creating the distribution, so when the distribution is
produced it will resolve to the versioned jar properly.
But I'm not sure if this is even usefull for a commons component where
the real product is the actual jar file and not the distribution tar
ball. I know I pushed for using SNAPSHOT earlier. But, maybe it would
make more sense if these were specific versions that we increment to a
specific release of other commons components.
The only issues that arise have to do with not getting too far ahead of
or behind the present state of our dependences.
-Mark
J.Pietschmann wrote:
> Hi,
> is there a way to tell maven not to reload the three SNAPSHOT
> jars without secifying "--offline" (which may cause failure
> due to other missing jars)?
> Could we use release jars instead of snapshots?
>
> Further notices:
> There are a few FIXME comments. I've configured my Eclipse to
> mark FIXMEs, but the out-of-the-box config highlights only TODOs.
> Can we agree on a common style here?
> I also get a lot of checkstyle warnings for operators placed at
> the beginning of a line. This is both Old Emacs style as well as
> Eclipse's auto formatting style. I have no idea how the Eclipse
> auto formatter can be told to put the operators at the end of
> the line. Also, I personally find operators at the end of the line
> awful too, although it is more consistent with common line breaking
> rules in documents.
> Questions: where's the "operator at previous line end" originating?
> Are there IDEs/formatters which auto-format operators at the end
> of the previous line?
> Can/should we revert to "operator at the beginning of the line"?
>
> Is there some way to order JavaDoc to tell the correct line for its
> warnings? I get them consistently wrong, by an unpredictable amount.
>
> J.Pietschmann
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: commons-dev-help@jakarta.apache.org
>
--
Mark Diggory
Software Developer
Harvard MIT Data Center
http://www.hmdc.harvard.edu
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [math] Maven build and elements of style
Posted by "Mark R. Diggory" <md...@latte.harvard.edu>.
Now in hindsight, you may be correct concerning this.
From my understanding, Maven will resolve SNAPSHOTS to thier proper
build number when creating the distribution, so when the distribution is
produced it will resolve to the versioned jar properly.
But I'm not sure if this is even usefull for a commons component where
the real product is the actual jar file and not the distribution tar
ball. I know I pushed for using SNAPSHOT earlier. But, maybe it would
make more sense if these were specific versions that we increment to a
specific release of other commons components.
The only issues that arise have to do with not getting too far ahead of
or behind the present state of our dependences.
-Mark
J.Pietschmann wrote:
> Hi,
> is there a way to tell maven not to reload the three SNAPSHOT
> jars without secifying "--offline" (which may cause failure
> due to other missing jars)?
> Could we use release jars instead of snapshots?
>
> Further notices:
> There are a few FIXME comments. I've configured my Eclipse to
> mark FIXMEs, but the out-of-the-box config highlights only TODOs.
> Can we agree on a common style here?
> I also get a lot of checkstyle warnings for operators placed at
> the beginning of a line. This is both Old Emacs style as well as
> Eclipse's auto formatting style. I have no idea how the Eclipse
> auto formatter can be told to put the operators at the end of
> the line. Also, I personally find operators at the end of the line
> awful too, although it is more consistent with common line breaking
> rules in documents.
> Questions: where's the "operator at previous line end" originating?
> Are there IDEs/formatters which auto-format operators at the end
> of the previous line?
> Can/should we revert to "operator at the beginning of the line"?
>
> Is there some way to order JavaDoc to tell the correct line for its
> warnings? I get them consistently wrong, by an unpredictable amount.
>
> J.Pietschmann
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: commons-dev-help@jakarta.apache.org
>
--
Mark Diggory
Software Developer
Harvard MIT Data Center
http://www.hmdc.harvard.edu
Re: [math] Maven build and elements of style
Posted by "J.Pietschmann" <j3...@yahoo.de>.
Mark R. Diggory wrote:
>> Now, Eclipse does allow the definition of local project task tags.
>> Maybe it would make sense to build a .project file for math that
>> contained these configurations, then add it to the cvs so that all
>> Eclipse users actually can use it without needing to customize Eclipse
>> for each tag?
>>
>
> Hmm, unfortunately it looks like that information isn't actually stored
> in .project, sorry.
>
No, it's global rather than project local.
But you can put suggestions somewhere into the Wiki. Start here
(lots of dummy text still):
http://nagoya.apache.org/wiki/apachewiki.cgi?ToolChest
J.Pietschmann
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [math] Maven build and elements of style
Posted by "J.Pietschmann" <j3...@yahoo.de>.
Mark R. Diggory wrote:
>> Now, Eclipse does allow the definition of local project task tags.
>> Maybe it would make sense to build a .project file for math that
>> contained these configurations, then add it to the cvs so that all
>> Eclipse users actually can use it without needing to customize Eclipse
>> for each tag?
>>
>
> Hmm, unfortunately it looks like that information isn't actually stored
> in .project, sorry.
>
No, it's global rather than project local.
But you can put suggestions somewhere into the Wiki. Start here
(lots of dummy text still):
http://nagoya.apache.org/wiki/apachewiki.cgi?ToolChest
J.Pietschmann
Re: [math] Maven build and elements of style
Posted by "Mark R. Diggory" <md...@latte.harvard.edu>.
Mark R. Diggory wrote:
> Now, Eclipse does allow the definition of local project task tags. Maybe
> it would make sense to build a .project file for math that contained
> these configurations, then add it to the cvs so that all Eclipse users
> actually can use it without needing to customize Eclipse for each tag?
>
Hmm, unfortunately it looks like that information isn't actually stored
in .project, sorry.
--
Mark Diggory
Software Developer
Harvard MIT Data Center
http://www.hmdc.harvard.edu
Re: [math] Maven build and elements of style
Posted by "Mark R. Diggory" <md...@latte.harvard.edu>.
Mark R. Diggory wrote:
> Now, Eclipse does allow the definition of local project task tags. Maybe
> it would make sense to build a .project file for math that contained
> these configurations, then add it to the cvs so that all Eclipse users
> actually can use it without needing to customize Eclipse for each tag?
>
Hmm, unfortunately it looks like that information isn't actually stored
in .project, sorry.
--
Mark Diggory
Software Developer
Harvard MIT Data Center
http://www.hmdc.harvard.edu
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
RE: [math] Maven build and elements of style
Posted by Brent Worden <br...@worden.org>.
> >
> > I replaced "@todo" with "TODO:" while fixing the JavaDoc warnings.
> > Questions:
> > - "TODO" (without colon), as recognized by Eclipse out-of-the-box,
> > or "TODO:" (with colon)? I used the latter, more for aestethics.
> > Will Maven recognize "TODO"?
> > - What about the "FIXME"? Replace with "TODO:"?
> >
>
> +1 on TODO as Eclipse uses out of the box. (because when creating a TODO
> with Eclipse it will be minus the ':').
>
> http://maven.apache.org/reference/plugins/javadoc/properties.html
>
I have no problems with either TODO or TODO: and dropping the use of @todo.
We lose the report generation, but since Eclipse (and other IDEs, I assume)
handles TODO the report loses a lot of its value. Plus, Eclipse and TODO do
not have any location restriction where as Maven and @todo forces all
comments in javadoc segments.
>
> -Mark
>
> --
> Mark Diggory
> Software Developer
> Harvard MIT Data Center
> http://www.hmdc.harvard.edu
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: commons-dev-help@jakarta.apache.org
>
Brent Worden
http://www.brent.worden.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
RE: [math] Maven build and elements of style
Posted by Brent Worden <br...@worden.org>.
> >
> > I replaced "@todo" with "TODO:" while fixing the JavaDoc warnings.
> > Questions:
> > - "TODO" (without colon), as recognized by Eclipse out-of-the-box,
> > or "TODO:" (with colon)? I used the latter, more for aestethics.
> > Will Maven recognize "TODO"?
> > - What about the "FIXME"? Replace with "TODO:"?
> >
>
> +1 on TODO as Eclipse uses out of the box. (because when creating a TODO
> with Eclipse it will be minus the ':').
>
> http://maven.apache.org/reference/plugins/javadoc/properties.html
>
I have no problems with either TODO or TODO: and dropping the use of @todo.
We lose the report generation, but since Eclipse (and other IDEs, I assume)
handles TODO the report loses a lot of its value. Plus, Eclipse and TODO do
not have any location restriction where as Maven and @todo forces all
comments in javadoc segments.
>
> -Mark
>
> --
> Mark Diggory
> Software Developer
> Harvard MIT Data Center
> http://www.hmdc.harvard.edu
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: commons-dev-help@jakarta.apache.org
>
Brent Worden
http://www.brent.worden.org
Re: [math] Maven build and elements of style
Posted by "Mark R. Diggory" <md...@latte.harvard.edu>.
J.Pietschmann wrote:
> Robert Leland wrote:
>
>> Borland popularized the @todo, which I use. Maven, or one of the
>> plug-ins, also recognized the
>> 'TODO:' so there are no javadoc warnings.
>
>
> I replaced "@todo" with "TODO:" while fixing the JavaDoc warnings.
> Questions:
> - "TODO" (without colon), as recognized by Eclipse out-of-the-box,
> or "TODO:" (with colon)? I used the latter, more for aestethics.
> Will Maven recognize "TODO"?
> - What about the "FIXME"? Replace with "TODO:"?
>
+1 on TODO as Eclipse uses out of the box. (because when creating a TODO
with Eclipse it will be minus the ':').
http://maven.apache.org/reference/plugins/javadoc/properties.html
@todo can be added as a property to the maven properties, then these
would not throw exceptions. (See the bottom of the page).
Logically this would mean that whatever tags we define in the properties
would be usable within mavens javadoc.
Now, Eclipse does allow the definition of local project task tags. Maybe
it would make sense to build a .project file for math that contained
these configurations, then add it to the cvs so that all Eclipse users
actually can use it without needing to customize Eclipse for each tag?
> There are also some comments containing "NOTE:" at the beginning
> of each comment line. As a matter of consistent style, should this
> be removed?
>
+1 these should just be regular text comments.
> I had the idea of building a "setup your IDE for work with Apache
> projects" guide in the Wiki, unfortunately, there isn't much content
> yet there. If "FIXME" should be recognized (or "TODO:" instead of
> "TODO") this should be put there.
>
this makes sense. but I think FIXME should just be TODO.
-Mark
--
Mark Diggory
Software Developer
Harvard MIT Data Center
http://www.hmdc.harvard.edu
Re: [math] Maven build and elements of style
Posted by "Mark R. Diggory" <md...@latte.harvard.edu>.
J.Pietschmann wrote:
> Robert Leland wrote:
>
>> Borland popularized the @todo, which I use. Maven, or one of the
>> plug-ins, also recognized the
>> 'TODO:' so there are no javadoc warnings.
>
>
> I replaced "@todo" with "TODO:" while fixing the JavaDoc warnings.
> Questions:
> - "TODO" (without colon), as recognized by Eclipse out-of-the-box,
> or "TODO:" (with colon)? I used the latter, more for aestethics.
> Will Maven recognize "TODO"?
> - What about the "FIXME"? Replace with "TODO:"?
>
+1 on TODO as Eclipse uses out of the box. (because when creating a TODO
with Eclipse it will be minus the ':').
http://maven.apache.org/reference/plugins/javadoc/properties.html
@todo can be added as a property to the maven properties, then these
would not throw exceptions. (See the bottom of the page).
Logically this would mean that whatever tags we define in the properties
would be usable within mavens javadoc.
Now, Eclipse does allow the definition of local project task tags. Maybe
it would make sense to build a .project file for math that contained
these configurations, then add it to the cvs so that all Eclipse users
actually can use it without needing to customize Eclipse for each tag?
> There are also some comments containing "NOTE:" at the beginning
> of each comment line. As a matter of consistent style, should this
> be removed?
>
+1 these should just be regular text comments.
> I had the idea of building a "setup your IDE for work with Apache
> projects" guide in the Wiki, unfortunately, there isn't much content
> yet there. If "FIXME" should be recognized (or "TODO:" instead of
> "TODO") this should be put there.
>
this makes sense. but I think FIXME should just be TODO.
-Mark
--
Mark Diggory
Software Developer
Harvard MIT Data Center
http://www.hmdc.harvard.edu
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
RE: [math] Maven build and elements of style
Posted by Brent Worden <br...@worden.org>.
> Will Maven recognize "TODO"?
No, it only recognizes javadoc tags.
>
> J.Pietschmann
>
Brent Worden
http://www.brent.worden.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
RE: [math] Maven build and elements of style
Posted by Brent Worden <br...@worden.org>.
> Will Maven recognize "TODO"?
No, it only recognizes javadoc tags.
>
> J.Pietschmann
>
Brent Worden
http://www.brent.worden.org
Re: [math] Maven build and elements of style
Posted by "J.Pietschmann" <j3...@yahoo.de>.
Robert Leland wrote:
> Borland popularized the @todo, which I use. Maven, or one of the
> plug-ins, also recognized the
> 'TODO:' so there are no javadoc warnings.
I replaced "@todo" with "TODO:" while fixing the JavaDoc warnings.
Questions:
- "TODO" (without colon), as recognized by Eclipse out-of-the-box,
or "TODO:" (with colon)? I used the latter, more for aestethics.
Will Maven recognize "TODO"?
- What about the "FIXME"? Replace with "TODO:"?
There are also some comments containing "NOTE:" at the beginning
of each comment line. As a matter of consistent style, should this
be removed?
I had the idea of building a "setup your IDE for work with Apache
projects" guide in the Wiki, unfortunately, there isn't much content
yet there. If "FIXME" should be recognized (or "TODO:" instead of
"TODO") this should be put there.
J.Pietschmann
Re: [math] Maven build and elements of style
Posted by "J.Pietschmann" <j3...@yahoo.de>.
Robert Leland wrote:
> Borland popularized the @todo, which I use. Maven, or one of the
> plug-ins, also recognized the
> 'TODO:' so there are no javadoc warnings.
I replaced "@todo" with "TODO:" while fixing the JavaDoc warnings.
Questions:
- "TODO" (without colon), as recognized by Eclipse out-of-the-box,
or "TODO:" (with colon)? I used the latter, more for aestethics.
Will Maven recognize "TODO"?
- What about the "FIXME"? Replace with "TODO:"?
There are also some comments containing "NOTE:" at the beginning
of each comment line. As a matter of consistent style, should this
be removed?
I had the idea of building a "setup your IDE for work with Apache
projects" guide in the Wiki, unfortunately, there isn't much content
yet there. If "FIXME" should be recognized (or "TODO:" instead of
"TODO") this should be put there.
J.Pietschmann
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [math] Maven build and elements of style
Posted by Robert Leland <rl...@apache.org>.
Brent Worden wrote:
>>There are a few FIXME comments. I've configured my Eclipse to
>>mark FIXMEs, but the out-of-the-box config highlights only TODOs.
>>Can we agree on a common style here?
>>
>>
>
>I've been placing @todo messages inside javadoc comments.
>PRO: Maven can generate a task list report based on those tags.
>CON: They show up as warnings in the javadoc report. (I haven't looked to
>see if I can disable this).
>
>
Borland popularized the @todo, which I use. Maven, or one of the
plug-ins, also recognized the
'TODO:' so there are no javadoc warnings.
RE: [math] Maven build and elements of style
Posted by Brent Worden <br...@worden.org>.
> There are a few FIXME comments. I've configured my Eclipse to
> mark FIXMEs, but the out-of-the-box config highlights only TODOs.
> Can we agree on a common style here?
I've been placing @todo messages inside javadoc comments.
PRO: Maven can generate a task list report based on those tags.
CON: They show up as warnings in the javadoc report. (I haven't looked to
see if I can disable this).
> I also get a lot of checkstyle warnings for operators placed at
> the beginning of a line. This is both Old Emacs style as well as
> Eclipse's auto formatting style. I have no idea how the Eclipse
> auto formatter can be told to put the operators at the end of
> the line. Also, I personally find operators at the end of the line
> awful too, although it is more consistent with common line breaking
> rules in documents.
> Questions: where's the "operator at previous line end" originating?
> Are there IDEs/formatters which auto-format operators at the end
> of the previous line?
> Can/should we revert to "operator at the beginning of the line"?
If your using eclipse 2.x, you might try the 3.0 milestone builds. They
were suppose contain a more configurable java editor.
>
> Is there some way to order JavaDoc to tell the correct line for its
> warnings? I get them consistently wrong, by an unpredictable amount.
Don't know. I have a hard enough time just reading it. I personally look
for method names at let those guide my work. I've also configured the
checkstyle plugin for eclipse to complain most javadoc warnings. There is a
lot of overlap between the two and it's a lot easier to find warnings using
eclipses task list than the javadoc report.
>
> J.Pietschmann
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: commons-dev-help@jakarta.apache.org
>
>
>
Brent Worden
http://www.brent.worden.org
RE: [math] Maven build and elements of style
Posted by Brent Worden <br...@worden.org>.
> There are a few FIXME comments. I've configured my Eclipse to
> mark FIXMEs, but the out-of-the-box config highlights only TODOs.
> Can we agree on a common style here?
I've been placing @todo messages inside javadoc comments.
PRO: Maven can generate a task list report based on those tags.
CON: They show up as warnings in the javadoc report. (I haven't looked to
see if I can disable this).
> I also get a lot of checkstyle warnings for operators placed at
> the beginning of a line. This is both Old Emacs style as well as
> Eclipse's auto formatting style. I have no idea how the Eclipse
> auto formatter can be told to put the operators at the end of
> the line. Also, I personally find operators at the end of the line
> awful too, although it is more consistent with common line breaking
> rules in documents.
> Questions: where's the "operator at previous line end" originating?
> Are there IDEs/formatters which auto-format operators at the end
> of the previous line?
> Can/should we revert to "operator at the beginning of the line"?
If your using eclipse 2.x, you might try the 3.0 milestone builds. They
were suppose contain a more configurable java editor.
>
> Is there some way to order JavaDoc to tell the correct line for its
> warnings? I get them consistently wrong, by an unpredictable amount.
Don't know. I have a hard enough time just reading it. I personally look
for method names at let those guide my work. I've also configured the
checkstyle plugin for eclipse to complain most javadoc warnings. There is a
lot of overlap between the two and it's a lot easier to find warnings using
eclipses task list than the javadoc report.
>
> J.Pietschmann
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: commons-dev-help@jakarta.apache.org
>
>
>
Brent Worden
http://www.brent.worden.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org