apache / apache/maven

[MNG-5926] Allow for comment elements inside POM

Open
#7,510 6 comments 0 reactions 0 assignees View on GitHub
enhancement priority:trivial
Dominant language
Java
Stars
5.3k
Forks
3.1k
Avg merge
20h 42m
Merged PRs (30d)
297

Description

**[James Green](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=jmkgreen)** opened **[MNG-5926](https://issues.apache.org/jira/browse/MNG-5926?redirect=false)** and commented

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 \ element to be permitted within a \, \, 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...

---

**Issue Links:**
- [MNG-5803](https://issues.apache.org/jira/browse/MNG-5803) Support for comments in POM
(_**"duplicates"**_)
- [MNG-3879](https://issues.apache.org/jira/browse/MNG-3879) Dependency map and documentation

**Remote Links:**
- [Page
](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=65875544)
- [Mailing list discussion
](http://www.mail-archive.com/users%40maven.apache.org/msg134578.html)

2 votes, 5 watchers

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.