Coding standards for Java are essential if you work on a Java project in your company, and you’re not working alone. Indeed, you need to deal with every team’s challenge: discuss, align and decide what your coding standards should be in your context. Not only Java besides, but all conventions related to naming, architecture, security, performance, or a framework. For instance, you may want to define conventions for frameworks such as Spring or Hibernate.
Defining your best practices as a team is an excellent knowledge-sharing exercise, which will positively impact the quality of source code.
In this post, we’ll see:
The Promyze platform and its plugins suite cover all of these scenarios. You’ll need an account on Promyze Cloud of Self-Hosted to follow this tutorial.
With Promyze, the creation process of best practices is as follows:
An IDE is probably where, as a developer, you spend most of your time writing and reading source code. So it looks like a great place to catch best practices, right?
If you develop Java, you’re likely to use JetBrains or Eclipse; those two are among the list of supported IDEs by Promyze. Btw, we’ve dedicated an entire post on how to use IntelliJ to share your best coding practice, and the concepts are very similar for Eclipse. Once the Promyze plugin has been set up on IntelliJ, you can get your API Key in Promyze and add it to the plugin configuration.
We’re ready to create our first Java best practice!
Let’s see how to achieve that with a Spring boot example:
Please be aware that you can also use our code review plugins to create best practices. These Web browser extensions integrate with GitLab, GitHub, Azure DevOps & Bitbucket.
Imagine every developer in your team can achieve that operation a few times per week or months as soon as they have a discussion topic related to a coding standard for Java, or any other topic. This asynchronous contribution process is the entry point for a synchronous workshop called Craft Workshops in Promyze. That’s a technical meeting where you use Promyze as a support to review contributions and decide which one to keep or not. It helps developers make technical decisions regarding best coding practices in their context.
This meeting happens typically monthly or twice, depending on your contribution rhythm. You can run a Workshop whenever you want with Promyze.
This retrieval and sharing can be achieved at two levels:
If you start to build your repository of practices and coding standards, it’s a significant first step achieved! But you can go further with Promyze to make this knowledge executable:
Also, all your practices will be available in a dedicated tab in IntelliJ or Eclipse, so you don’t have to switch contexts.
Ready to create your coding standards for Java with your team?
Promyze, the collaborative platform dedicated to improve developers’ skills through best practices sharing and definition.
Crafted from Bordeaux, France.