Manual:Coding conventions/Java

From mediawiki.org
Jump to navigation Jump to search
Other languages:

This page describes the coding conventions used within files of the MediaWiki codebase written in Java. See also the general conventions that apply to all program languages, including Java.

MediaWiki Java code is inspired by the Google Java Style. It differs at least in the following:

  • indent with 4 spaces

A Checkstyle configuration file is used for verification by the Maven Checkstyle Plugin. This file is bundled in the discovery-maven-tool-configs project and can be used as a dependency as shown in the discovery-parent-pom project.

Various other conventions are embodied in the plugin configurations found in the discovery-parent-pom project. See the README.md in that project for additional documentation. You can use that parent pom directly, or pick the pieces which makes the most sense for a specific project.