Author: svn-site-role
Date: Sat Jun 21 17:13:00 2025
New Revision: 1926626
Log:
Site checkin for project Apache Maven Site
Modified:
maven/website/content/developers/conventions/code.html
Modified: maven/website/content/developers/conventions/code.html
==============================================================================
--- maven/website/content/developers/conventions/code.html (original)
+++ maven/website/content/developers/conventions/code.html Sat Jun 21 17:13:00
2025
@@ -144,8 +144,6 @@
<section><a id="Maven_Code_Style_And_Code_Conventions"></a>
<h1>Maven Code Style And Code Conventions</h1>
<p>This document describes the rules for how the sources should be formatted
in order to improve consistency, readability and maintainability.</p>
-<p>As the formatting is automatically enforced or even applied with <a
class="externalLink"
href="https://github.com/diffplug/spotless/tree/main/plugin-maven";>spotless-maven-plugin</a>
for all projects using <a href="/pom/maven/index.html">Maven Project Parent
POM 38 or newer</a> developers usually don't need to care and the following
sections are just for informational purposes.</p>
-<p>Optionally you can still import the code style formatter for your IDE from
<a class="externalLink"
href="https://gitbox.apache.org/repos/asf?p=maven-shared-resources.git;a=tree;f=src/main/resources/config;hb=HEAD";>shared-resources</a></p>
<ul>
<li><a href="#Generic_Code_Style_And_Convention">Generic Code Style And
Convention</a></li>
<li><a href="#Java">Java</a>
@@ -173,7 +171,8 @@
<p><b>Note</b>: The specific styles and conventions, listed in the next
sections, can override these generic rules.</p></section><section><a
id="Java"></a>
<h2>Java</h2><section><a id="Java_Code_Style"></a>
<h3>Java Code Style</h3>
-<p>Maven adopts the <a class="externalLink"
href="https://github.com/palantir/palantir-java-format";>palantir Java
format</a>.</p></section><section><a id="Java_Code_Convention"></a>
+<p>Maven adopts the <a class="externalLink"
href="https://github.com/palantir/palantir-java-format";>palantir Java
format</a>. The code formatting of Java files is enforced by the <a
class="externalLink"
href="https://github.com/diffplug/spotless/tree/main/plugin-maven";>spotless-maven-plugin</a>
for all projects using <a href="/pom/maven/index.html">Maven Project Parent
POM 38 or newer</a>. You can format the code by running the command <i>mvn
spotless:apply</i>.</p>
+<p>You can download the code style formatter for your IDE from <a
class="externalLink"
href="https://gitbox.apache.org/repos/asf?p=maven-shared-resources.git;a=tree;f=src/main/resources/config;hb=HEAD";>shared-resources</a>.
To format Java code, there are plugins for many IDEs on the <a
class="externalLink"
href="https://github.com/palantir/palantir-java-format";>palantir Java format
GitHub page</a> too.</p></section><section><a id="Java_Code_Convention"></a>
<h3>Java Code Convention</h3>
<p>For consistency reasons, our Java code convention is mainly:</p>
<ul>
