Actually I think <comment> ought to be possible within pretty much any "instruction" within the POM:
A dependency management item A dependency A build profile A build plugin However the first two are probably the most useful and were my original desire. Now I can imagine this becoming the start of a more descriptive set of declarations to describe the "whys" of a project but this kicks things off in a pretty generic way. And it's not just for the reader of an XML file to avoid going down a bunch of upgrades to discover "why" there's a really old pinned library the project doesn't even directly depend on. It's potentially useful for interpreters elsewhere: imagine GitHub/IDE decide to provide a POM viewer and it shows the comments within this. Might provide explanations as to security matters and perceived bloat. On 17 April 2015 at 16:55, Sander Verhagen <san...@sanderverhagen.net> wrote: > Hi, > > > I'm wondering how useful it would be to have "a" (one) comment on a > dependency. Would you rather not have commenting be an attribute of (yes, > indeed) a dependency, but also more-specifically of an exclusion, a scope > designation, etc.? > > What would be some of the actual comments that you are thinking of here? > Perhaps this would come to life a bit more with a few good examples. > > Sander. > > > > Sander Verhagen > [ san...@sanderverhagen.net ] > > > -----Original Message----- > > From: Gary Gregory [mailto:garydgreg...@gmail.com] > > Sent: Friday, April 17, 2015 8:45 > > To: Maven Users List > > Subject: Re: Adding comments to dependencies in POM > > > > +1 > > Gary > > > > -------- Original message -------- > > From: James Green <james.mk.gr...@gmail.com> > > Date: 04/17/2015 04:58 (GMT-08:00) > > To: Maven Users List <users@maven.apache.org> > > Subject: Re: Adding comments to dependencies in POM > > > > [ Dragging up a really old topic. ] > > > > https://issues.apache.org/jira/browse/MNG-5803 > > > > Incidentally I would vote against a different namespace as comments are > > likely to be of use to readers of Maven POMs even if they are used for > visual > > purposes. > > > > > > On 27 August 2014 at 12:03, Robert Scholte <rfscho...@apache.org> wrote: > > > > > I think it should be solved with a separate namespace, so the model > > > parsing stays pure without metadata irrelevant for Maven. > > > And it should already work right now, no need for the pom xsd to > > > change, since the Maven pom-parser should ignore these kinds of > > elements/attributes. > > > > > > Robert > > > > > > Op Wed, 27 Aug 2014 12:15:00 +0200 schreef domi <d...@fortysix.ch>: > > > > > > > > > +1 > > >> I think this would be a good idea, let us know about the issue, so we > > >> can vote on it. > > >> Domi > > >> > > >> On 27.08.2014, at 09:12, James Green <james.mk.gr...@gmail.com> > > wrote: > > >> > > >> I have in the past wasted hours of effort trying to weed out > > >>dependency > > >>> issues where something has been added for reasons unknown. Removal > > >>> leads to breakage. > > >>> > > >>> It would be helpful if, inside a POM, it were possible to add a > > >>> comment element to a dependency. I realise this is possible as an > > >>> XML comment, however having a POM field would let documentation > > >>> engines record the comment. > > >>> > > >>> The same could be said for dependencies inside > > dependencyManagement. > > >>> > > >>> It would of course have the side effect of auto completion within > > >>> IDEs showing authors how to "officially" comment on the reason for > > that work. > > >>> > > >>> An idea. > > >>> > > >>> James > > >>> > > >> > > >> > > >> --------------------------------------------------------------------- > > >> To unsubscribe, e-mail: users-unsubscr...@maven.apache.org > > >> For additional commands, e-mail: users-h...@maven.apache.org > > >> > > > > > > --------------------------------------------------------------------- > > > To unsubscribe, e-mail: users-unsubscr...@maven.apache.org > > > For additional commands, e-mail: users-h...@maven.apache.org > > > > > > >
