maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "James Green (JIRA)" <>
Subject [jira] [Commented] (MNG-5926) Allow for comment elements inside POM
Date Tue, 06 Dec 2016 11:11:25 GMT


James Green commented on MNG-5926:

As specified in the original ticket, XML comments will be stripped out before any tools that
read the Project Object Model and will be lost at this point.

if anyone writes a POM parser to provide, for instance, automatic documentation, such comments
as "Why this dependency is needed" or "why this dependency exclusion is needed" will be immediately
lost without an official element.

We are starting to see real progress in the area of automated project assessment tools - it
is a shame we cannot annotate our POM requirements for future colleagues to understand /why/
things are the way they are /until/ they reach the XML file itself.

> Allow for comment elements inside POM
> -------------------------------------
>                 Key: MNG-5926
>                 URL:
>             Project: Maven
>          Issue Type: Improvement
>          Components: POM
>            Reporter: James Green
>            Priority: Trivial
>             Fix For: Issues to be reviewed for 4.x
> I have spent hours tracking down why something exists as it does within a company POM.
On multiple occasions.
> All because there is no obvious documentation for things like dependencies. Yes, we could
use XML comments but these will not show in the results of any documentation tools.
> What I am asking for is a <comment> element to be permitted within a <dependency>,
<exclusion>, and probably a few other areas but those are real immediate areas of need.
> This was discussed briefly on the -users mailing list many months ago and was generally
met with approval. I can't remember adding it here though...

This message was sent by Atlassian JIRA

View raw message