Maven 文档风格指南
风格从何而来？
创建文档样式指南是为了使我们的文档更加一致，并将最佳实践应用于文档。该标准刚刚开始，并将根据 Maven 开发邮件列表中提出的建议随着时间的推移而扩展。这是我们应该如何编写文档的社区共识。
本指南中的每条规则都应带有其存在的动机。鼓励引用外部资源。
日期格式
世界各地的人们格式化日期的方式各不相同，有时让人们很难相互理解。这个问题的解决方案以 ISO-8601 标准的形式出现。
我们文档中的日期必须遵循以下标准：
YYYY-MM-DD
其中YYYY是公历中的年份，MM是介于 01（一月）和 12（十二月）之间的月份， DD是介于 01 和 31 之间的月份。
注意：所有文档元数据都应该遵守这个约定，例如对于这个给定的 APT 文档：
------ Guide To Maven Documentation Style ------ Dennis Lundberg ------ 2008-07-03 ------
参考
POM 片段
POM 文件的每个缩进必须使用 2 个空格。因为 POM 片段经常在文档中用于向用户展示如何配置某些东西，所以这些片段不要太宽是很重要的。如果它们太宽，则很难在较小的屏幕上阅读页面。
当您使用 POM 中的 XML 片段作为文档中的示例时，请确保该示例正确缩进。用户应该能够在不更改缩进的情况下将示例复制并粘贴到他们自己的 POM 中。
此外，您应该声明所有父 POM 元素以提高理解能力。如果您不想指定元素，可以使用省略号（即...）。
例子
以下是如何配置Maven站点的分发管理的示例。
<project>
...
<distributionManagement>
<site>
<id>apache.website</id>
<url>scp://people.apache.org/www/maven.apache.org/</url>
</site>
</distributionManagement>
...
</project>正如您在上面看到的，<distributionManagement>元素缩进一次（=2 个空格），<site>元素缩进两次（=4 个空格），并且<id>缩进 3 次（=6 个空格）。
命名文档文件
所有文件名都应该用连字符 (-) 替换空格，例如对于这个给定的 APT 文档：
guide-documentation-style.apt
更新文档文件
一个好的做法是在更新文档文件时更新日期（使用正确的日期格式）。
写思考
以下是输入材料时有关英语规则的一些提示：